Doxygen parse javadoc?

Question

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?

albert · Accepted Answer · 2019-03-26 10:46:04Z

7

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

edited Mar 26, 2019 at 10:46

albert

9,2003 gold badges24 silver badges42 bronze badges

answered Jan 14, 2011 at 17:29

Dusty Campbell

3,15631 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Doxygen parse javadoc?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related