Removes out-of-date version information from source files and obsolete info from README.

Author: manoelcampos

README.md

@@ -10,10 +10,6 @@ interactive Digital Television (DTV) [Ginga NCL applications](http://gingancl.or
 
 The original parser was written by Paul Chakravarti and is available on [LuaUsers](http://lua-users.org/wiki/LuaXml).
 
-The code (and documentation) is not complete yet, however it is usable and this release is intended to avoid potential duplication between efforts and get early feedback.
-
-The API is relatively stable however there may be some detailed changes.
-
 # Installation
 If you clone this repository, you are download all the module source code and can run the examples directly.
 However, if you want to use the module inside your own project, the best way is to download it using 

XmlParser.lua

@@ -1,25 +1,21 @@
---- @module Class to parse XML
+--- @module Class providing the actual XML parser.
+--  Available options are:
+--      * stripWS   
+--        Strip non-significant whitespace (leading/trailing) 
+--        and do not generate events for empty text elements
+--  
+--      * expandEntities 
+--        Expand entities (standard entities + single char 
+--        numeric entities only currently - could be extended 
+--        at runtime if suitable DTD parser added elements
+--        to table (see obj._ENTITIES). May also be possible
+--        to expand multibyre entities for UTF-8 only
+--  
+--      * errorHandler
+--        Custom error handler function 
+--
+--  NOTE: Boolean options must be set to 'nil' not '0'
 local XmlParser = {
-    --  Available options are -
-    --  
-    --      * stripWS   
-    --      
-    --        Strip non-significant whitespace (leading/trailing) 
-    --        and do not generate events for empty text elements
-    --  
-    --      * expandEntities 
-    --  
-    --        Expand entities (standard entities + single char 
-    --        numeric entities only currently - could be extended 
-    --        at runtime if suitable DTD parser added elements
-    --        to table (see obj._ENTITIES). May also be possible
-    --        to expand multibyre entities for UTF-8 only
-    --  
-    --      * errorHandler
-    --  
-    --        Custom error handler function 
-    --
-    --  NOTE: Boolean options must be set to 'nil' not '0'
     options     = {},
     handler     = {},
 

testxml.lua

@@ -3,12 +3,6 @@
 ---Simple command line test parser - applies handler[s] specified
 -- to XML file (or STDIN) and dumps results<br/>
 --
--- $Id: testxml.lua,v 1.1.1.1 2001/11/28 06:11:33 paulc Exp $<br/>
---
--- $Log: testxml.lua,v $<br/>
--- Revision 1.1.1.1  2001/11/28 06:11:33  paulc<br/>
--- Initial Import
---
 
 require("xml2lua")
 local treeHandler = require("xmlhandler/tree")

xml2lua.lua

@@ -1,4 +1,4 @@
---- @module This module provides a non-validating XML stream parser in Lua. 
+--- @module Module providing a non-validating XML stream parser in Lua. 
 --  
 --  Features:
 --  =========
@@ -37,7 +37,6 @@
 --  callbacks for each XML element processed (if a suitable handler
 --  function is defined). The API is conceptually similar to the 
 --  SAX API but implemented differently.
---  
 --
 --  XML data is passed to the parser instance through the 'parse'
 --  method (Note: must be passed a single string currently)

xmlhandler/README.md

@@ -7,7 +7,7 @@ There are currently 3 available handlers:
 - dom: generates a DOM-like node tree structure with a single ROOT node parent.
 
 # Usage
-To get a handler instance you must call, for instance, `handler = require("xmlhandler/tree")`.
+To get a handler instance you must call, for instance, `handler = require("xmlhandler.tree")`.
 Then, you have to use one the handler instance when getting an instance of the XML parser using `parser = xml2lua.parser(handler)`.
 Notice the module `xml2lua` should have been loaded before using `require("xml2lua")`.
 This way, the handler is called internally when the `parser:parse(xml)` function is called.

xmlhandler/dom.lua

@@ -8,7 +8,7 @@
 --              _parent = <Parent Node>
 --              _children = { List of child nodes - ROOT/NODE only }
 --            }
---      where PI stands for XML processing instructions
+--      where PI stands for XML processing instructions.
 --
 --      The dom structure is capable of representing any valid XML document
 --

xmlhandler/tree.lua

@@ -1,6 +1,6 @@
 
 --- @module XML Tree Handler.
--- Generate a lua table from an XML content string.
+-- Generates a lua table from an XML content string.
 -- It is a simplified handler which attempts 
 -- to generate a more 'natural' table based structure which
 -- supports many common XML formats.