Changeset 2976

Timestamp:

08/27/08 19:49:52 (5 years ago)

Author:

Cyrus

Message:

Rewrote the API-documentation for luci.json

Files:

• ff-luci/trunk/libs/json/luasrc/json.lua (modified) (6 diffs)

ff-luci/trunk/libs/json/luasrc/json.lua

@@ -56 +56 @@
 local getmetatable = getmetatable
 
+--- LuCI JSON-Library
 module "luci.json"
 
@@ -64 +65 @@
 end
 
-
+--- JSON-Encoder
+-- @class   module
+-- @cstyle  instance
+-- @name    luci.json.Encoder
 Encoder = util.class()
 
 --- Creates a new Encoder.
--- @param data          Data to be encoded.
--- @param buffersize    Buffersize of returned data.
+-- @param data          Lua-Object to be encoded.
+-- @param buffersize    Blocksize of returned data source.
 -- @param fastescape    Use non-standard escaping (don't escape control chars) 
 function Encoder.__init__(self, data, buffersize, fastescape)
@@ -80 +84 @@
 end
 
---- Create an LTN12 source from the encoder object
+--- Create an LTN12 source providing the encoded JSON-Data.
 -- @return LTN12 source
 function Encoder.source(self)
@@ -208 +212 @@
 
 
-
+--- JSON-Decoder
+-- @class   module
+-- @cstyle  instance
+-- @name    luci.json.Decoder
 Decoder = util.class()
 
 --- Create a new Decoder object.
--- @param customnull User luci.json.null instead of nil
+-- @param customnull Use luci.json.null instead of nil
 function Decoder.__init__(self, customnull)
     self.cnull = customnull
@@ -218 +225 @@
 end
 
---- Create an LTN12 sink from the decoder object.
+--- Create an LTN12 sink from the decoder object which accepts the JSON-Data.
 -- @return LTN12 sink
 function Decoder.sink(self)
@@ -228 +235 @@
 
 
---- Get the decoded data packets
+--- Get the decoded data packets after the rawdata has been sent to the sink.
 -- @return Decoded data
 function Decoder.get(self)