Natural Docs |
Natural Docs is a multi-language documentation generator written in Perl and licensed under the GPL. It attempts to keep the comments written in source code just as readable as the generated documentation. It is written and maintained by Greg Valure.
=Example=
This is an example of the documentation style. See [http://www.naturaldocs.org/documenting.html the full syntax reference] for more details.
/* * Function: Multiply * * Multiplies two integers. * * Parameters: * * x - The first integer. * y - The second integer. * * Returns: * * The two integers multiplied together. * * See Also: * * */ int Multiply (int x, int y) { return x * y; };
You can also see an [http://www.naturaldocs.org/documentation/html/ example of the generated documentation.]
=More Information=
*[http://www.naturaldocs.org Natural Docs Home Page] *[http://www.naturaldocs.org/features.html List of features] *[http://www.naturaldocs.org/languages.html List of supported languages]
=See Also=
*List of documentation generators *Comparison of documentation generators|
|