Re: [Doxygen-users] Briefer comments

[Clemens F. <c....@os...>]

> From: Florian Lindner
> Date: 15.07.2014 10:56
>
> Hello,
>
> I have a lot of comments like that:
>
>    /**
>     * @brief Limit of iterations during one timestep.
>     */
>    int _maxIterations;
>
> which makes it three lines of code for one line of comment. What is the best
> way to achieve the same commentary with one line of code?
>
> At http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html all comments
> are multi-line.
>
> Thanks,
> Florian
>

Hi Florian.

It is too easy to write one-liners:

/** Limit of iterations during one timestep. */
int _maxIterations;

//! Limit of iterations during one timestep.
int _maxIterations;

/// Limit of iterations during one timestep.
int _maxIterations;

int _maxIterations; ///< Limit of iterations during one timestep.


If you have  JAVADOC_AUTOBRIEF=YES then you can omitt the @brief:

JAVADOC_AUTOBRIEF=NO:

/** @brief Limit of iterations during one timestep. More than one 
sentence ... */
int _maxIterations;

JAVADOC_AUTOBRIEF=YES:

/// Limit of iterations during one timestep. More than one sentence ...
int _maxIterations;

Clemens