Make Doxygen support Lua
Perl Lua
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin upload to github Jan 14, 2010
example update on example.lua for local function Oct 18, 2011
lib/Doxygen Merge pull request #3 from eljeko/master Jul 14, 2012
t first commit Jan 14, 2010
Changes upload to github Jan 14, 2010
MANIFEST upload to github Jan 14, 2010
Makefile.PL remove Moose Jul 18, 2011
README update README Jan 15, 2010
ignore.txt first commit Jan 14, 2010



Doxygen::Lua is a preprocessor to make Doxygen support Lua syntax.

A script named "lua2dox" is shipped with this module. Just simply
modify your Doxyfile as below:

    FILTER_PATTERNS = *.lua=/path/to/your/lua2dox

That's all! Then you can document lua files as same as c files! 

The default doxygen mark is '--!'. It can be chnaged by "mark" method.
Please see Doxygen::Lua perldoc for detail information.

Run "doxygen" in the "example" directory can generate a example documentation.


To install this module, run the following commands:

	perl Makefile.PL
	make test
	make install


After installing, you can find documentation for this module with the
perldoc command.

    perldoc Doxygen::Lua

You can also look for information at:

    RT, CPAN's request tracker

    AnnoCPAN, Annotated CPAN documentation

    CPAN Ratings

    Search CPAN


Copyright (C) 2010 Alec Chen

This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.

See for more information.