diff --git a/README.html b/README.html index cc20c06d..bd82b9a3 100644 --- a/README.html +++ b/README.html @@ -393,7 +393,7 @@ The requires bcel to be on the class path, and the ClassLoader of JSE o

Globals

The old notion of platform has been replaced with creation of globals. -The Globals +The Globals class holds global state needed for executing closures as well as providing convenience functions for compiling and loading scripts. @@ -404,7 +404,7 @@ Typically, a platform is used to construct a Globals, which is then provided as environment for client scripts.

JsePlatform

-The JsePlatform +The JsePlatform class can be used as a factory for globals in a typical Java SE application. All standard libraries are included, as well as the luajava library. The default search path is the current directory, @@ -429,7 +429,7 @@ which can be built using build-applet.xml.

JmePlatform

-The JmePlatform +The JmePlatform class can be used to set up the basic environment for a Java ME application. The default search path is limited to the jar resources, and the math operations are limited to those supported by Java ME. @@ -473,7 +473,7 @@ Considerations include
  • Portions of the os, io, and coroutine libraries are prone to abuse
  • Rogue scripts may need to be throttled or killed
  • Shared metatables (string, booleans, etc.) need to be made read-only or isolated via class loaders -such as LuajClassLoader +such as LuajClassLoader Luaj provides sample code covering various approaches: @@ -555,8 +555,8 @@ as with the yield-from-anywhere patch in C-based lua.

    Luaj uses WeakReferences and the OrphanedThread error to ensure that coroutines that are no longer referenced are properly garbage collected. For thread safety, OrphanedThread should not be caught by Java code. -See LuaThread -and OrphanedThread +See LuaThread +and OrphanedThread javadoc for details. The sample code in examples/jse/CollectingOrphanedCoroutines.java provides working examples. @@ -607,7 +607,7 @@ The lua connand line tool includes luajava.

    API Javadoc

    The javadoc for the main classes in the LuaJ API are on line at 
    -	 http://luaj.sourceforge.net/api/3.0
+	 http://luaj.org/luaj/3.0/api
    You can also build a local version from sources using @@ -617,10 +617,10 @@ You can also build a local version from sources using

    LuaValue and Varargs

    All lua value manipulation is now organized around -LuaValue +LuaValue which exposes the majority of interfaces used for lua computation. 
    -	 org.luaj.vm2.LuaValue
+	 org.luaj.vm2.LuaValue

    Common Functions

    @@ -643,12 +643,12 @@ Some commonly used functions and constants include:

    Varargs

    -The interface Varargs provides an abstraction for +The interface Varargs provides an abstraction for both a variable argument list and multiple return values. For convenience, LuaValue implements Varargs so a single value can be supplied anywhere variable arguments are expected. 
    -	 org.luaj.vm2.Varargs
+	 org.luaj.vm2.Varargs

    Common Functions

    @@ -662,18 +662,18 @@ variable arguments are expected. optlong(int n,long d); // return n if a long, d if no argument, or error if not a long -See the Varargs API for a complete list. +See the Varargs API for a complete list.

    LibFunction

    The simplest way to implement a function is to choose a base class based on the number of arguments to the function. LuaJ provides 5 base classes for this purpose, depending if the function has 0, 1, 2, 3 or variable arguments, and if it provide multiple return values. 
    -	 org.luaj.vm2.lib.ZeroArgFunction
-	 org.luaj.vm2.lib.OneArgFunction
-	 org.luaj.vm2.lib.TwoArgFunction
-	 org.luaj.vm2.lib.ThreeArgFunction
-	 org.luaj.vm2.lib.VarArgFunction
+	 org.luaj.vm2.lib.ZeroArgFunction
+	 org.luaj.vm2.lib.OneArgFunction
+	 org.luaj.vm2.lib.TwoArgFunction
+	 org.luaj.vm2.lib.ThreeArgFunction
+	 org.luaj.vm2.lib.VarArgFunction
    Each of these functions has an abstract method that must be implemented, @@ -777,7 +777,7 @@ For this example to work the code in hyperbolic.java must be compiled a Closures still exist in this framework, but are optional, and are only used to implement lua bytecode execution, and is generally not directly manipulated by the user of luaj.

    -See the org.luaj.vm2.LuaClosure +See the org.luaj.vm2.LuaClosure javadoc for details on using that class directly.

    6 - Parser

    @@ -827,7 +827,7 @@ An example that prints locations of all function definitions in a file may be fo

    -See the org.luaj.vm2.ast package javadoc for the API relating to the syntax tree that is produced. +See the org.luaj.vm2.ast package javadoc for the API relating to the syntax tree that is produced.

    7 - Building and Testing

    @@ -925,7 +925,8 @@ Files are no longer hosted at LuaForge.
  • JSR-223 enhancement: allow both ".lua" and "lua" as extensions in getScriptEngine()
  • JSR-223 fix: use system class loader to support using luaj as JRE extension
  • Improve selection logic when binding to overloaded functions using luajava
    • -
  • Enhance javadoc, put it in distribution and on line
    • +
  • Enhance javadoc, put it in distribution +and at http://luaj.sourceforge.net/api/2.0/
  • Major refactor of luajava type coercion logic, improve method selection.
  • Add lib/luaj-sources-2.0.2.jar for easier integration into an IDE such as Netbeans
    • @@ -1012,6 +1013,7 @@ Files are no longer hosted at LuaForge.
  • Add sample code that illustrates techniques in creating sandboxed environments.
  • Add convenience methods to Global to load string scripts with custom environment.
  • Turn off default traceback. Use xpcall() with debug.traceback instead.
    • +
  • Move online docs to http://luaj.org/luaj/3.0/api/