Doxygen parse javadoc?

I am wondering if Doxygen will parse Javadoc comments? - that is, doxygen accepts something like 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 yet, is there a better way to make these comments, doxygen style?

+3
source share
1 answer

Doxygen accepts a similar syntax for JavaDoc, but not quite the same. Your sample comment will be recognized except for the command @ret. The correct command in doxygen is @return.

Here are examples on the doxygen website:

http://www.stack.nl/~dimitri/doxygen/docblocks.html

+5
source

Source: https://habr.com/ru/post/1784929/


All Articles