# Post your Doxygen comment style

This topic is 4763 days old which is more than the 365 day threshold we allow for new replies. Please post a new topic.

## Recommended Posts

Hi, I have a "serious" problem. This is the current style I'm using:
     //! This is the brief description of this function.
//
//! \param Param1 This is an important parameter
//! \param Param2 This is also an important parameter
void MyFunc(int Param1, int Param2);

The problem is, this screws seriously up if there is only one line in the detailed section (behaviour is by design):
     //! This is the brief description of this function.
//
//! \param Param1 This won't show up in the docs
void MyFunc(int Param1);

I tried several other layouts but all looked ugly, so I'm looking for some inspiration... TrueTom PS: Yes, I don't have any other problems... ;)

##### Share on other sites
The only downside with this style, if it can even be considered a downside, is that you have to use the "function" tag, but then I don't think that's altogether a bad thing.

//=========================================================================//! @function    Console::AddOutputListener//! @brief       Add an output listener//!//!				 An output listener is an object that will be automatically//!				 updated every time text is written to the console              //!//! @param       listener [in] Listener object //!              //! @return      A connection object between the event and the event handler//=========================================================================

1. 1
Rutin
46
2. 2
3. 3
4. 4
5. 5
JoeJ
19

• 11
• 15
• 9
• 10
• 13
• ### Forum Statistics

• Total Topics
633004
• Total Posts
3009836
• ### Who's Online (See full list)

There are no registered users currently online

×