[Olena-patches] Re: oln 10.94: Doc (transform).

>>> "Akim" == Akim Demaille <akim@epita.fr> writes:

>>> "Giovanni" == Giovanni Palma <giovanni@lrde.epita.fr> writes:
 >> +      /// \brief Accessor to ith element of g.
 >> const value_t getG(unsigned i) const { return g[i]; }
 >> +      /// \brief Accessor to ith element of ig.
 >> const value_t getInvG(unsigned i) const { return ig[i]; }
 >> +      /// \brief Accessor to ith element of h.
 >> const value_t getH(unsigned i) const { return h[i]; }
 >> +      /// \brief Accessor to ith element of ih.
 >> const value_t getInvH(unsigned i) const { return ih[i]; }
 >> -
 >> +      /// \brief Give the size of the arrays.
 >> const unsigned size() const { return size_; }

 > Ce genre de \brief est inutile (documentation en une seule ligne).
 > C'est bcp plus sympa a` lire sans.

Mon message n'est pas clair.  Je veux que ``\brief'' lui-même est
inutile quand ça tient sur une ligne, désolé.

http://www.stack.nl/~dimitri/doxygen/docblocks.html

   3. A third option is to use a special C++ style comment which does
      not span more than one line. Here are two examples:

      /// Brief description. 
      /** Detailed description. */

      or

      //! Brief descripion. 

      //! Detailed description 
      //! starts here.

      Note the blank line in the last example, which is required to
      separate the brief description from the block containing the
      detailed description. The JAVADOC_AUTOBRIEF should also be set
      to NO for this case.