Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
Doxygen-Lua 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. INSTALLATION To install this module, run the following commands: perl Makefile.PL make make test make install SUPPORT AND DOCUMENTATION 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 http://rt.cpan.org/NoAuth/Bugs.html?Dist=Doxygen-Lua AnnoCPAN, Annotated CPAN documentation http://annocpan.org/dist/Doxygen-Lua CPAN Ratings http://cpanratings.perl.org/d/Doxygen-Lua Search CPAN http://search.cpan.org/dist/Doxygen-Lua/ LICENSE AND COPYRIGHT 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 http://dev.perl.org/licenses/ for more information.