开发者

Doxygen javadoc-style tag description spanning multiple lines

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 yo开发者_StackOverflowu 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?


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.

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜