diff options
| author | Determinant <ted.sybil@gmail.com> | 2016-04-28 12:54:26 +0800 |
|---|---|---|
| committer | Determinant <ted.sybil@gmail.com> | 2016-04-28 12:54:26 +0800 |
| commit | 53d59b9fff59d657c024673a9a0b54b396feb8d6 (patch) | |
| tree | d0bbd6e296fdfe03fb0f0f270719360c202cd783 /nerv/io/init.lua | |
| parent | e4c6f4a6b7c537969fdea4abcebdfda884fa3bbc (diff) | |
add doc
Diffstat (limited to 'nerv/io/init.lua')
| -rw-r--r-- | nerv/io/init.lua | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/nerv/io/init.lua b/nerv/io/init.lua index 4ebbabf..f0a3d52 100644 --- a/nerv/io/init.lua +++ b/nerv/io/init.lua @@ -11,7 +11,7 @@ -- * `write(handle)`: define how to write to a file handle -- * `get_info()`: return a table of chunk metadata -- * `set_info(info)`: set the metadata of the chunk --- * for more information, please refer to `nerv.MatrixParam` as an example +-- * for more information, please refer to `nerv.MatrixParam` as an example. -- @type nerv.ChunkFile function nerv.ChunkFile:write_chunkdata(metadata, writer) @@ -80,7 +80,7 @@ function DataReader:__init(global_conf, reader_conf) nerv.error_method_not_implemented() end ---- Get a data block from the reader +--- Get a data block from the reader. -- @return a table which maps data slot identifiers to data matrices. A data -- slot identifier is a unique string naming one slot of data. Each identifier -- maps to a matrix containing the data. (`{<slot_id> = <data matrix>, ...}`) It |