> 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 ------------------------------------------------------------------------------ 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 Doxygen-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/doxygen-users
