开发者

How to define own doxygen comment styles?

开发者 https://www.devze.com 2023-01-09 08:16 出处:网络
I would like to know whether it is possible to define own doxygen comment styles. The usual style is something like this (Javadoc-like):

I would like to know whether it is possible to define own doxygen comment styles. The usual style is something like this (Javadoc-like):

/**
*
*   Descriptions and stuff
*
*/

or (when using Qt):

/*!
*
*   Descriptions and stuff
*
*/

I would pr开发者_如何学编程efer something like

/*!===============================================================
*
*   Descriptions and stuff
*
================================================================*/

But the doxygen parser doesn't allow this syntax. So my questions is, if there is a way to define own comment styles.


I don't think you can define your own comment styles, but with some slight changes to the format, it might match.

See this page on documentation blocks in the Doxygen documentation:

Some people like to make their comment blocks more visible in the documentation. For this purpose you can use the following:

/********************************************//**
 *  ... text
 ***********************************************/

(note the 2 slashes to end the normal comment block and start a special comment block).

or

/////////////////////////////////////////////////
/// ... text ...
/////////////////////////////////////////////////
0

精彩评论

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

关注公众号