keplerproject / luadoc Goto Github PK

View Code? Open in Web Editor NEW

84.0 11.0 26.0 426 KB

LuaDoc is obsolete, use LDoc instead →

Home Page: https://github.com/stevedonovan/LDoc

CSS 9.24% Lua 88.22% Makefile 2.42% Batchfile 0.12%

luadoc's Introduction

LuaDoc is obsolete, use LDoc instead.

LuaDoc, version 3.0
Tomas Guisasola ([email protected])
http://luadoc.luaforge.net
13/aug/2007

What is it?

LuaDoc is a documentation generator tool for Lua source code. It parses the declarations and documentation comments in a set of Lua source files and produces a set of XHTML pages describing the commented declarations and functions.

The output is not limited to XHTML. Other formats can be generated by implementing new doclets. The format of the documentation comments is also flexible and can be customized by implementing new taglets. Please refer to customizing section for further information.

LuaDoc is free software and uses the same license as Lua.

Distribution:

This distribution includes a set of Lua files and this README. It requires Lua 5.1.

Installation:

LuaDoc tool is composed by two parts, a library, and a launcher script.

The library follows the package model for Lua 5.1, therefore it should be "installed".

The launcher script, namely luadoc.lua for Unix and luadoc.bat for Windows, should be installed in your system PATH, so that it can be executed.

LuaDoc also depends on two external packages: LuaFileSystem and LuaLogging, and you'll need to install them accordingly.

On Unix boxes, the file luadoc.lua could be used as a script; it's the same as:

lua5.1 luadoc.lua [options|files]

This is the main script: it will load LuaDoc library and process the specified files. Try luadoc.lua --help, it will show you all available options.

How does it work?

LuaDoc works in two phases: analysis and synthesis. On the first one, all input files are analyzed and an intermediate structure is made with this information. The second phase is responsible for cross-reference and the composition of the output. Each phase has an engine file and one or more description files, that describe the source format and the output format. This distribution only have a description of Lua source files and another for HTML output files.

Some technical documentation can be built running LuaDoc over its files.

Please send any comments and bug reports to [email protected]

luadoc's People

Contributors

Stargazers

Watchers

luadoc's Issues

Couple of suggestions

Hello,

i really like your project LuaDoc. Everything seems to be perfect but i lack one feature here. Lua is a dinamically typed language so it is hard for a programmer to know what type parameter function should expect or what type the return is. So i thought it would be really handly to have a notation of a param and return types. E.g. @param where first would stand for parameter name and second could be a parameter type. Same with @return where would be a parameter type.

I would love to know your opinion about this matter.
Waiting for you response.

Regards,
Povilas Balciunas

Commenting after documenting

I would like to comment after a documentation doc. The real reason being that I have another parser running. So I need to do something like:

    --- Lua Doc
    -- @param whatever
    -- ...
    ---
    -- My comment

Note that I expect lua Doc to stop reading after the ---.
Otherwise I need to put a line of code in between. Something I dont want.

I havent tried it really but would a blank line have the effect I desire?

    --- Lua Doc
    -- @param whatever
    -- ...

    -- My comment

NOTICE: This project was discontinued, use LDoc instead

Please refer to https://github.com/stevedonovan/ldoc instead. Thank you!

attempt to call field 'gfind' (a nil value)

The gfind method was deprecated in Lua 5.1, and in Lua 5.2 (and LuaJIT, which is what I'm using) it doesn't exist any more - it was replaced by gmach.

If compatibility with Lua 5.0 isn't needed, then this can be fixed by replacing gfind by gmatch in src/luadoc/doclet/html.lua and src/luadoc/util.lua. If compatibility is desired, then in both of those files something like this is needed:

local gmatch = string.gfind or string.gmatch
...
for d in gmatch(...)

I can provide a PR for any of the two alternatives. Please let me know which one is preferred.

Mismatches for "module" keyword in block comments

Having the word "module" in a block comment can cause LuaDoc to interpret it as a module name, even if not syntactically valid. e.g.:

--[[ this causes a module named "nonexistent module" to appear in the documentation
module nonexistent module, more text here
]]

--[[ this causes a module named "tag[1" to appear
module[tag[1]] = foo
]]

Releases

Hi folks,

Is there any reason for not having releases avaliable?

Thanks,

keplerproject / luadoc Goto Github PK

luadoc's Introduction

What is it?

Distribution:

Installation:

How does it work?

luadoc's People

Contributors

Stargazers

Watchers

Forkers

luadoc's Issues

Couple of suggestions

Commenting after documenting

NOTICE: This project was discontinued, use LDoc instead

attempt to call field 'gfind' (a nil value)

Mismatches for "module" keyword in block comments

Releases

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent