Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Doxygen parse javadoc?

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?

like image 469
Skeen Avatar asked Jan 12 '11 10:01

Skeen


People also ask

What is @brief in doxygen?

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.

How do I show code in doxygen?

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.

How do I comment out a code in doxygen C++?

Once specified, you can generate the comment stub by typing the respective “///” or “/**” above a function, or by using the (Ctrl+/) shortcut.


1 Answers

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

like image 121
Dusty Campbell Avatar answered Oct 30 '22 20:10

Dusty Campbell