doxygen-users

[Doxygen-users] Briefer comments

[Florian L. <mai...@xg...>]

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

Re: [Doxygen-users] Briefer comments

[Stefan L. <kai...@ex...>]

Hi Florian.

>From your link I can tell that for example
int _maxIterations; ///< Limit of iterations during one timestep.
Should work.

Just scroll a bit down for a lot of alternatives regarding 2 liners and 1
liners and choose the one that you like most.

Kind regards,
Stefan.
-----Original Message-----
From: Florian Lindner [mailto:mai...@xg...]
Sent: Tuesday, July 15, 2014 10:56 AM
To: dox...@li...
Subject: [Doxygen-users] Briefer comments

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


--------------------------------------------------------------------------
----
Want fast and easy access to all the code in your enterprise? Index and
search up to 200,000 lines of code with a free copy of Black Duck Code
Sight - the same software that powers the world's largest code search on
Ohloh, the Black Duck Open Hub! Try it now.
http://p.sf.net/sfu/bds
_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

-- 
--
Exit Games | www.exitgames.com | @exitgames | +49 40 413 596 0

Executives Christof Wegmann CTO, Wim de Smet CFO
Trade Registry / Amtsgericht Hamburg, Germany HRB 85991

++ Add Chat: http://j.mp/PhotonChat
++ Start Turnbased: http://j.mp/PhotonTurnbased
++ Unity Networking that just works: http://j.mp/PhotonUnity
++ Follow http://twitter.com/exitgames for Photon announcements

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