Doc::Simply - Generate POD-like documentation from embedded comments in JavaScript, Java, C, C++ source
Version 0.03
doc-simply < source.js > documentation.html doc-simply --help
Doc::Simply is bundled with doc-simply, a command-line application that transforms (special) comments into documentation
doc-simply
It is modeled after Plain Old Documentation but it is not an exact mimic
* The input document is expected to have JavaScript, Java, C, C++-style comments: /* ... */ // ... * The output document is HTML * The markup style is POD-like, e.g. =head1, =head2, =body, ... * The formatting style is Markdown (instead of the usual C<>, L<>, ...)
/* * @head1 NAME * * Calculator - Add 2 + 2 and return the result * */ // @head1 DESCRIPTION // @body Add 2 + 2 and return the result (which should be 4) /* * @head1 FUNCTIONS * * @head2 twoPlusTwo * * Add 2 and 2 and return 4 * */ function twoPlusTwo() { return 2 + 2; // Should return 4 }
Text::Markdown
http://daringfireball.net/projects/markdown/syntax
You can contribute or fork this project via GitHub:
http://github.com/robertkrimen/doc-simply/tree/master
git clone git://github.com/robertkrimen/doc-simply.git Doc-Simply
Robert Krimen, <rkrimen at cpan.org>
<rkrimen at cpan.org>
Please report any bugs or feature requests to bug-doc-simply at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Doc-Simply. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-doc-simply at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Doc::Simply
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Doc-Simply
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Doc-Simply
CPAN Ratings
http://cpanratings.perl.org/d/Doc-Simply
Search CPAN
http://search.cpan.org/dist/Doc-Simply
Copyright 2008 Robert Krimen, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Doc::Simply, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Doc::Simply
CPAN shell
perl -MCPAN -e shell install Doc::Simply
For more information on module installation, please visit the detailed CPAN module installation guide.