I'm curious as to if Doxygen parses Javadoc comments? - that is, does doxygen accept something alike this:
/**
Greet with a "Hello" message.
@param a string containing the name of the person or entity
@ret return a string containing "Hello" and the name of the greeted person or entity.
*/
public String sayHello(string name)
{
return "Hello" + name;
}
And another thing, is there a more correct way of doing these comments, doxygen style?
Putting the command @brief will generate a short description of the function when you generate the doxygen documentation. That short description can be extended if you want.
You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.
Once specified, you can generate the comment stub by typing the respective “///” or “/**” above a function, or by using the (Ctrl+/) shortcut.
Doxygen accepts similar syntax to JavaDoc, but not exactly the same. Your example comment would be recognized, except for the @ret
command. The correct command in doxygen is @return
.
Here are the examples on doxygen's website:
http://www.doxygen.nl/manual/docblocks.html
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With