Tell me more ×
Stack Overflow is a question and answer site for professional and enthusiast programmers. It's 100% free, no registration required.

In a C++ project I'm using doxygen and the javadoc style for documentation. I'm fairly new to javadoc and am not sure whether this type of thing is valid.

/**
 * ...stuff...
 * @return foo foo foo foo foo. Foo foo
 * foo foo foo foo foo.
 */

i.e. the information for what is being returned (and my question applies to all tags) needs to cover multiple lines. Is this automatically detected or do I need to do something special?

Also, from what I understand you can have a short class description and a more in depth class description. Like the problem above, can the short class description be more than one line? If so, what is the syntax for this?

share|improve this question

1 Answer

up vote 0 down vote accepted

The doxygen docs state that

If {curly} braces are used the argument extends until the next paragraph. Paragraphs are delimited by a blank line or by a section indicator.

The return command is listed as a paragraph-style command. So you can use as many lines as you want, add one extra blank line or just start a new command to end the return.

share|improve this answer

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.