search

lunarmodules / ldoc

LDoc is a LuaDoc-compatible documentation generator which can also process C extension source. Markdown may be optionally used to render comments, as well as integrated readme documentation and pretty-printed example files.
https://lunarmodules.github.io/ldoc/
Other
794 stars 173 forks source link

LDoc doesn't play well with C++ code that is already documented by doxygen #252

Open mgerhardy opened 8 years ago

mgerhardy commented 8 years ago 
/***
 * @file
 * @ingroup LUA
 * @module REGISTRY
 */

Something like this would be nice - but right now it just errors out with unknown tag and "Module already declared".

Or maybe I'm doing something wrong?

mgerhardy commented 8 years ago

oh. btw. If I just use the doxygen header:

/***
 * @file
 * @ingroup LUA
 */

I'm getting this:

/home/mgerhardy/dev/simpleai/src/ai/LUAAIRegistry.h:5: ?: unknown tag: 'ingroup' nil
/home/mgerhardy/dev/simpleai/src/ai/LUAAIRegistry.h:493: internal LDoc error
/usr/share/lua/5.1/ldoc/doc.lua:394: table index is nil
stack traceback:
    /usr/share/lua/5.1/ldoc/doc.lua:394: in function 'finish'
    /usr/share/lua/5.1/ldoc/parse.lua:404: in function </usr/share/lua/5.1/ldoc/parse.lua:404>
    [C]: in function 'xpcall'
    /usr/share/lua/5.1/ldoc/parse.lua:404: in function 'file'
    /usr/bin/ldoc:408: in function 'process_file'
    /usr/bin/ldoc:498: in main chunk
    [C]: ?