View on
MetaCPAN
陳衍良 > Doxygen-Lua > Doxygen::Lua

Download:
Doxygen-Lua-0.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.04   Source  

NAME ^

Doxygen::Lua - Make Doxygen support Lua

VERSION ^

Version 0.04

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:

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.

syntax highlighting: