CODEWITHSUNDEEP
commentscustomizationdoxygen
Exa
Exa

Reputation: 4110

How to define own doxygen comment styles?

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 prefer 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.

Upvotes: 4

Views: 1745

Answers (1)

tomlogic
tomlogic

Reputation: 11694

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 ...
/////////////////////////////////////////////////

Upvotes: 2

Related Questions