Doxygen javadoc style tag description spanning multiple lines

Question

In a C ++ project, I use doxygen and the javadoc style for documentation. I am new to javadoc and not sure if this type is really valid.

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

i.e. the information about what is being returned (and my question applies to all tags) should span multiple lines. Is it automatically detected or do I need to do something special?

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

Answer 1

doxygen docs claim that

If curly braces are used, the argument continues until the next paragraph. Items are separated by an empty line or section indicator.

The return command appears as a paragraph style command. This way you can use as many lines as you want, add one extra empty line or just run a new command to end return .