A small project exist to add a lua pre-processor in doxygen.

https://github.com/alecchen/doxygen-lua

I think we must add this to buildbot and start lua documentation.

Looks like that uses perl as a backend. I like perl, but do we want to add
another programming language?

We don't. :)

Mhhh...

I don't understand why we would have to 'add' an other language.

If someone wants to generate the doxydoc, he has to install doxygen,
graphviz and so on.
If he also wants to generate the doc of lua scripts (such as
script_helpers.lua), then he will also have to install lua2dox.

What we just have to do is to change our doxyfile to instruct doxygen
to filter lua files through that lua2dox. And if the user did not
install it, doxygen will just complain about a not found file, and do its work
anyhow.

I agree with fluzz. Lua2dox is just a tool, not a library we add to freedroid.

I'm currently checking it and also an other filter written in lua (lua2dox.lua).

doxygen-lua generates smart documentation (with function members, data members,
...), but line numbers are wrong.

lua2dox.lua gives right line numbers, but the generated documentation does not
separate functions from data.

So, I will add doxygen-lua and use it to document the next to come new dialog
engine written in Lua, and I'll try to patch that filter later (I'm not a Perl
programmer) to have it generating the right line numbers.

On 09/25/2012 12:52 PM, Xenux - Roundup wrote:
>
> New submission from Xenux <netwak@hotmail.fr>:
>
> A small project exist to add a lua pre-processor in doxygen.
>
> https://github.com/alecchen/doxygen-lua
>
> I think we must add this to buildbot and start lua documentation.
>

Interesting.

I'll give it a look.

Thanks.

> ----------
> messages: 2352
> priority: feature
> status: open
> title: Support lua for Doxygen
>
> ________________________________________
> FreedroidRPG issues <bugs@freedroid.org>
> <http://bugs.freedroid.org/b/issue613>
> ________________________________________
>
> ------------------------------------------------------------------------------
> Live Security Virtual Conference
> Exclusive live event will cover all the ways today's security and
> threat landscape has changed and how IT managers can respond. Discussions
> will include endpoint security, mobile security and the latest in malware
> threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
> _______________________________________________
> Freedroid-bugs mailing list
> Freedroid-bugs@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/freedroid-bugs
>

On 09/26/2012 09:11 AM, Arthur Huillet - Roundup wrote:
>
> Arthur Huillet<ahuillet@freedroid.org>  added the comment:
>
> We don't. :)
>

Mhhh...

I don't understand why we should have to 'add' an other language.

If someone wants to generate the doxydoc, he has to install doxygen,
graphviz and so on.
If he also wants to generate the doc of lua scripts (such as
script_helpers.lua), then he will also have to install lua2dox.

What we just have to do is to change our doxyfile to instruct doxygen
to filter lua files through that lua2dox. And if the user did not
installed it, doxygen will just complain about a not found file, and do
its work anyhow.