sterleft.blogg.se - Doxygen comment examples

#DOXYGEN COMMENT EXAMPLES HOW TO#
#DOXYGEN COMMENT EXAMPLES INSTALL#
#DOXYGEN COMMENT EXAMPLES GENERATOR#

Example: /home/jordan/workspace/PerlDoxygen/trunk/Doxyfile

#DOXYGEN COMMENT EXAMPLES HOW TO#

Please see the Doxygen manual for information on how to configure the Doxyfile via a text editor or with the doxywizard tool. You can edit this file with the doxywizard tool if you so desire or if you need to change the lib directory location or the output location (the default output is. This file will have all of the presets needed for documenting Perl code. Example: /usr/local/bin/doxygen-filter-perlĬopy over the Doxyfile file from this project into the root directory of your project so that it is at the same level as your lib directory. Make sure that the doxygen-filter-perl script was copied from this project into your path somewhere and that it has RX permissions.

#DOXYGEN COMMENT EXAMPLES INSTALL#

If you install from source then do: perl Makefile.PL

Install Doxygen::Filter::Perl via CPAN or from source. The Doxgyen style comment blocks for methods/functions can be inside or outside the method/function. We plan on supporting most Doxygen style comments and POD (plain old documentation) style comments. The Doxygen::Filter::Perl module is designed to provide support for documenting perl scripts and modules to be used with the Doxygen engine.

Documenting Subroutines/Functions/Methodsĭoxygen::Filter::Perl - A perl code pre-filter for Doxygen DESCRIPTION.

Support Style Options and Section Indicators.

If we change bool to boolean, and rename one_flip to oneFlip… we have a Java function. Both p and the possible return values are documented. * true if the result is heads and false if the result is tails Which one do I get for heads? Let us add an /** Now what about the return? We know that bool means a true or false. What does p represent? Does it represent the probability of heads or tails? /** The one_flip function needs a description.

#DOXYGEN COMMENT EXAMPLES GENERATOR#

Seed the random number generator with the current time Suppose we have just finished writing a quick program to simulate a trick coin (i.e., a coin where heads and tails are not equally probable). We revised the description for brevity and clarity.Īny time a function has a parameter it should be documented.We documented the input into the constructor (i.e., the parameter r) with an tag.* Create a Cookbook with a set recipe limit. The description should probably be cleaned up a little.

* r max number of recipes that can be stored. What does r represent? Let us start by adding r to the documentation /** * outs output destination (e.g., cout or a file) * Display the Cookbook with each recipe separator by `\n-\n`. * true if both `this` should be listed before `rhs`īool operator<(const Cookbook& rhs) const * recipes then compare each pair of recipes, basing lhs < rhs on the * - If lhs and rhs have the same number of recipes, sort each set of * - If lhs has fewer recipes than rhs, lhs < rhs.

* true if both this and rhs are Cookbooks with the same recipesīool operator=(const Cookbook& rhs) const * Compare two cookbooks based on the recipes they contain, ignoring the Void removeRecipe(const Recipe& to_remove) * part of this cookbook, this method becomes a no-op (it completes * `to_remove` is present in the cookbook. * to_remove recipe to remove from the cookbook * Create a Cookbook that can contain at most _r_ * Create a Cookbook that can contain at most MAX_RECIPES