#270: Properly use Doxygen grouping commands -----------------------+------------------------ Reporter: levill_r | Owner: Olena Team Type: defect | Status: new Priority: minor | Milestone: Component: Milena | Version: 1.0 Resolution: | Keywords: doc -----------------------+------------------------ Description changed by levill_r: Old description:

Ensure the following style is used uniformly in Olena when documentation grouping is required:

{{{ /// \name Code generation. /// \{

/* ... */

/// \} }}}

Do not omit the `\name` keyword!

New description: Ensure the following style is used uniformly in Olena when documentation grouping is required: {{{ /// \name Short documentation of the group. /// /// More documentation about the group. /// \{ /// Documentation of the function foo. int foo (int i); /// Documentation of the function bar. int bar (int i); /// \} }}} Pay attention to: * the `\name` keyword, which shall not be omitted; * the blank line after the line with the opening grouping brace (`\{`): if you omit it, Doxygen will treat the next comment (`Documentation of the function foo.`) as documentation for the group (i.e., similarly to `More documentation about the group.`). We should script these checks. -- -- Ticket URL: <https://trac.lrde.epita.fr/olena/ticket/270#comment:1> Olena <http://olena.lrde.epita.fr> Olena, a software platform dedicated to image processing.