• Advertisement
Sign in to follow this  

Post your Doxygen comment style

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

If you intended to correct an error in the post then please contact us.

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 this post


Link to post
Share on other sites
Advertisement
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
//=========================================================================

Share this post


Link to post
Share on other sites
Sign in to follow this  

  • Advertisement