Skip to content

sam-github/doc-lua

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

** doc-lua - a very simple documentation tool for lua

Usage:
    doc-lua *.c *.lua > API.TXT

Lua doc comments are contained in lightly formatted comment blocks.

For C, the comment begin must match regex "^/*-" and the end must match "^*/"

For Lua, the comment begin must match regex "^--[-" and the end must match "^]]".

Sections should look like:

    /*-
    ** Object - this does that

    more docs
    */

APIs should look like:

    /*-
    -- result = obj:dothis(arg [, optional])

    do this to an object
    */

About

doc-lua converts C and Lua inline comments to text documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages