• NAME
• VERSION
• SYNOPSIS
• DESCRIPTION
• SUBROUTINES/METHODS
  • new
  • parse
  • mark
• AUTHOR
• BUGS
• SUPPORT
• ACKNOWLEDGEMENTS
• REPOSITORY
• LICENSE AND COPYRIGHT

NAME

Doxygen::Lua - Make Doxygen support Lua

VERSION

Version 0.02

SYNOPSIS

    use Doxygen::Lua;
    my $p = Doxygen::Lua->new;
    print $p->parse($input);

DESCRIPTION

A script named "lua2dox" will be installed. Then modify your Doxyfile as below:

    FILTER_PATTERNS = *.lua=../bin/lua2dox

That's all!

SUBROUTINES/METHODS

new

This function will create a Doxygen::Lua object.

parse

This function will parse the given input file and return the result.

mark

This function will set the mark style. The default value is "--!".

AUTHOR

Alec Chen, <alec at cpan.org>

BUGS

Please report any bugs or feature requests to bug-doxygen-lua at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Doxygen-Lua. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

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/

ACKNOWLEDGEMENTS

REPOSITORY

See http://github.com/alecchen/doxygen-lua

LICENSE AND COPYRIGHT

Copyright 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.