documentation

README

@@ -46,6 +46,20 @@ use all conversion scripts in the 'scripts' directory like this:
 
     $ picaconv <script> <picafile>
 
+API Documentation
+-----------------
+You can generate the API documentation with LuaDoc. However, LuaDoc has
+not been updated since years. I added some patches, so you get get a
+fixed version of LuaDoc at https://github.com/nichtich/luadoc.
+
+    $ git clone git://github.com/nichtich/luadoc.git
+    $ cd luadoc
+    $ make install
+
+You can then generate documentation with:
+
+    $ make doc 
+
 Feedback and updates
 --------------------
 please visit https://github.com/nichtich/lua-pica

example.lua

@@ -1,3 +1,4 @@
+
     require 'pica'
 
     r = io.read("*all")           -- read from standard input

scripts/pica2rdf.lua

@@ -1,13 +1,15 @@
 -------------------------------------------------------------------------------
---- Experimental demo conversion from PICA+ to RDF/Turtle
--- @file
+-- Experimental demo conversion from PICA+ to RDF/Turtle.
+--
+-- @author Jakob Voss <voss@gbv.de>
 -------------------------------------------------------------------------------
 
 require 'pica'
 
 -------------------------------------------------------------------------------
 --- Simple turtle serializer.
 -- Stores multiple RDF statements with the same subject.
+-- 
 -- @class table
 -- @name Turtle
 -------------------------------------------------------------------------------
@@ -37,6 +39,8 @@ Turtle = {
     -- # ttl   returns the number of triples
 }
 
+--- Creates a new Turtle serializer.
+-- @param subject the subject for all triples
 function Turtle.new( subject )
     local tt = {
         subject = subject,

src/pica.lua

@@ -1,10 +1,11 @@
 -----------------------------------------------------------------------------
---- Handle PICA+ data in Lua.
+-- Handle PICA+ data in Lua.
 -- This module provides two classes (<a href="#PicaField">PicaField</a> and
 -- <a href="#PicaRecord">PicaRecord</a>) for PICA+ data. The programming 
 -- interface of these classes is optimized for easy access and conversion
--- of PICA+ records.
+-- of PICA+ records. Have a look at the file 'example.lua' for a synopsis.
 -- 
+-- @author Jakob Voss <voss@gbv.de>
 -- @class module
 -- @name pica
 -- @see PicaField