Move \ingroup before \brief in all Doxygen comments.

Using \ingroup between \brief and the rest of the documentation causes
Doxygen to concatenate the brief with the rest of the doc.

* src/sanity/style.test: Warn when \ingroup is found
on the line after \brief.
* src/kripke/fairkripke.hh, src/kripke/kripke.hh,
src/kripke/kripkeprint.hh, src/ltlast/atomic_prop.hh,
src/ltlast/automatop.hh, src/ltlast/binop.hh, src/ltlast/bunop.hh,
src/ltlast/constant.hh, src/ltlast/formula.hh, src/ltlast/multop.hh,
src/ltlast/refformula.hh, src/ltlast/unop.hh, src/ltlast/visitor.hh,
src/ltlenv/declenv.hh, src/ltlenv/defaultenv.hh,
src/ltlenv/environment.hh, src/ltlparse/ltlfile.hh,
src/ltlvisit/clone.hh, src/ltlvisit/destroy.hh, src/ltlvisit/dotty.hh,
src/ltlvisit/dump.hh, src/ltlvisit/length.hh, src/ltlvisit/lunabbrev.hh,
src/ltlvisit/mark.hh, src/ltlvisit/nenoform.hh, src/ltlvisit/postfix.hh,
src/ltlvisit/randomltl.hh, src/ltlvisit/reduce.hh,
src/ltlvisit/relabel.hh, src/ltlvisit/simpfg.hh,
src/ltlvisit/simplify.hh, src/ltlvisit/tunabbrev.hh,
src/ltlvisit/wmunabbrev.hh, src/misc/bddalloc.hh, src/misc/bddlt.hh,
src/misc/freelist.hh, src/misc/hash.hh, src/misc/ltstr.hh,
src/misc/minato.hh, src/misc/modgray.hh, src/misc/optionmap.hh,
src/misc/version.hh, src/saba/explicitstateconjunction.hh,
src/saba/saba.hh, src/saba/sabacomplementtgba.hh, src/saba/sabastate.hh,
src/saba/sabasucciter.hh, src/sabaalgos/sabadotty.hh,
src/sabaalgos/sabareachiter.hh, src/ta/ta.hh, src/ta/taproduct.hh,
src/ta/tgta.hh, src/taalgos/reachiter.hh, src/taalgos/tgba2ta.hh,
src/tgba/futurecondcol.hh, src/tgba/sba.hh, src/tgba/state.hh,
src/tgba/succiter.hh, src/tgba/tgba.hh, src/tgba/tgbabddconcrete.hh,
src/tgba/tgbabddconcreteproduct.hh, src/tgba/tgbakvcomplement.hh,
src/tgba/tgbaproduct.hh, src/tgba/tgbasafracomplement.hh,
src/tgba/tgbascc.hh, src/tgba/tgbasgba.hh, src/tgba/tgbatba.hh,
src/tgba/tgbaunion.hh, src/tgba/wdbacomp.hh, src/tgbaalgos/bfssteps.hh,
src/tgbaalgos/degen.hh, src/tgbaalgos/dotty.hh,
src/tgbaalgos/dottydec.hh, src/tgbaalgos/dupexp.hh,
src/tgbaalgos/eltl2tgba_lacim.hh, src/tgbaalgos/lbtt.hh,
src/tgbaalgos/ltl2taa.hh, src/tgbaalgos/ltl2tgba_fm.hh,
src/tgbaalgos/ltl2tgba_lacim.hh, src/tgbaalgos/neverclaim.hh,
src/tgbaalgos/powerset.hh, src/tgbaalgos/projrun.hh,
src/tgbaalgos/randomgraph.hh, src/tgbaalgos/reachiter.hh,
src/tgbaalgos/reducerun.hh, src/tgbaalgos/replayrun.hh,
src/tgbaalgos/rundotdec.hh, src/tgbaalgos/save.hh,
src/tgbaalgos/stripacc.hh, src/tgbaalgos/translate.hh: Move \ingroup
before \brief.

src/ltlvisit/clone.hh

@@ -30,8 +30,8 @@ namespace spot
 {
   namespace ltl
   {
-    /// \brief Clone a formula.
     /// \ingroup ltl_visitor
+    /// \brief Clone a formula.
     ///
     /// This visitor is public, because it's convenient
     /// to derive from it and override part of its methods.
@@ -60,13 +60,13 @@ namespace spot
     };
 
 #if __GNUC__
-    /// \brief Clone a formula.
     /// \ingroup ltl_essential
+    /// \brief Clone a formula.
     /// \deprecated Use f->clone() instead.
     const formula* clone(const formula* f) __attribute__ ((deprecated));
 #else
-    /// \brief Clone a formula.
     /// \ingroup ltl_essential
+    /// \brief Clone a formula.
     /// \deprecated Use f->clone() instead.
     const formula* clone(const formula* f);
 #endif

src/ltlvisit/destroy.hh

@@ -29,13 +29,13 @@ namespace spot
   namespace ltl
   {
 #if __GNUC__
-    /// \brief Destroys a formula
     /// \ingroup ltl_essential
+    /// \brief Destroys a formula
     /// \deprecated Use f->destroy() instead.
     void destroy(const formula *f) __attribute__ ((deprecated));
 #else
-    /// \brief Destroys a formula
     /// \ingroup ltl_essential
+    /// \brief Destroys a formula
     /// \deprecated Use f->destroy() instead.
     void destroy(const formula *f);
 #endif

src/ltlvisit/dotty.hh

@@ -27,8 +27,8 @@ namespace spot
 {
   namespace ltl
   {
-    /// \brief Write a formula tree using dot's syntax.
     /// \ingroup ltl_io
+    /// \brief Write a formula tree using dot's syntax.
     /// \param os The stream where it should be output.
     /// \param f The formula to translate.
     ///

src/ltlvisit/dump.hh

@@ -27,8 +27,8 @@ namespace spot
 {
   namespace ltl
   {
-    /// \brief Dump a formula tree.
     /// \ingroup ltl_io
+    /// \brief Dump a formula tree.
     /// \param os The stream where it should be output.
     /// \param f The formula to dump.
     ///

src/ltlvisit/length.hh

@@ -28,8 +28,8 @@ namespace spot
 {
   namespace ltl
   {
-    /// \brief Compute the length of a formula.
     /// \ingroup ltl_misc
+    /// \brief Compute the length of a formula.
     ///
     /// The length of a formula is the number of atomic propositions,
     /// constants, and operators (logical and temporal) occurring in
@@ -42,8 +42,8 @@ namespace spot
     /// to have length one.
     int length(const formula* f);
 
-    /// \brief Compute the length of a formula, squashing Boolean formulae
     /// \ingroup ltl_misc
+    /// \brief Compute the length of a formula, squashing Boolean formulae
     ///
     /// This is similar to spot::ltl::length(), except all Boolean
     /// formulae are assumed to have length one.

src/ltlvisit/lunabbrev.hh

@@ -29,9 +29,9 @@ namespace spot
 {
   namespace ltl
   {
+    /// \ingroup ltl_visitor
     /// \brief Clone and rewrite a formula to remove most of the
     /// abbreviated logical operators.
-    /// \ingroup ltl_visitor
     ///
     /// This will rewrite binary operators such as binop::Implies,
     /// binop::Equals, and binop::Xor, using only unop::Not, multop::Or,
@@ -54,9 +54,9 @@ namespace spot
       virtual const formula* recurse(const formula* f);
     };
 
+    /// \ingroup ltl_rewriting
     /// \brief Clone and rewrite a formula to remove most of the abbreviated
     /// logical operators.
-    /// \ingroup ltl_rewriting
     ///
     /// This will rewrite binary operators such as binop::Implies,
     /// binop::Equals, and binop::Xor, using only unop::Not, multop::Or,

src/ltlvisit/mark.hh

@@ -30,8 +30,8 @@ namespace spot
     class mark_tools
     {
     public:
-      /// \brief Mark operators NegClosure and EConcat.
       /// \ingroup ltl_rewriting
+      /// \brief Mark operators NegClosure and EConcat.
       ///
       /// \param f The formula to rewrite.
       const formula* mark_concat_ops(const formula* f);

src/ltlvisit/nenoform.hh

@@ -29,8 +29,8 @@ namespace spot
 {
   namespace ltl
   {
-    /// \brief Build the negative normal form of \a f.
     /// \ingroup ltl_rewriting
+    /// \brief Build the negative normal form of \a f.
     ///
     /// All negations of the formula are pushed in front of the
     /// atomic propositions.

src/ltlvisit/postfix.hh

@@ -29,9 +29,9 @@ namespace spot
 {
   namespace ltl
   {
+    /// \ingroup ltl_visitor
     /// \brief Apply an algorithm on each node of an AST,
     /// during a postfix traversal.
-    /// \ingroup ltl_visitor
     ///
     /// Override one or more of the postifix_visitor::doit methods
     /// with the algorithm to apply.

src/ltlvisit/randomltl.hh

@@ -31,8 +31,8 @@ namespace spot
   namespace ltl
   {
 
-    /// \brief Base class for random formula generators
     /// \ingroup ltl_io
+    /// \brief Base class for random formula generators
     class random_formula
     {
     public:
@@ -98,8 +98,8 @@ namespace spot
     };
 
 
-    /// \brief Generate random LTL formulae.
     /// \ingroup ltl_io
+    /// \brief Generate random LTL formulae.
     ///
     /// This class recursively constructs LTL formulae of a given
     /// size.  The formulae will use the use atomic propositions from
@@ -151,8 +151,8 @@ namespace spot
       random_ltl(int size, const atomic_prop_set* ap);
     };
 
-    /// \brief Generate random Boolean formulae.
     /// \ingroup ltl_io
+    /// \brief Generate random Boolean formulae.
     ///
     /// This class recursively constructs Boolean formulae of a given size.
     /// The formulae will use the use atomic propositions from the
@@ -191,8 +191,8 @@ namespace spot
       random_boolean(const atomic_prop_set* ap);
     };
 
-    /// \brief Generate random SERE.
     /// \ingroup ltl_io
+    /// \brief Generate random SERE.
     ///
     /// This class recursively constructs SERE of a given size.
     /// The formulae will use the use atomic propositions from the
@@ -234,8 +234,8 @@ namespace spot
       random_boolean rb;
     };
 
-    /// \brief Generate random PSL formulae.
     /// \ingroup ltl_io
+    /// \brief Generate random PSL formulae.
     ///
     /// This class recursively constructs PSL formulae of a given size.
     /// The formulae will use the use atomic propositions from the

src/ltlvisit/reduce.hh

@@ -76,8 +76,8 @@ namespace spot
 #endif
     /// @}
 
-    /// \brief Check whether a formula is a pure eventuality.
     /// \ingroup ltl_misc
+    /// \brief Check whether a formula is a pure eventuality.
     ///
     /// Pure eventuality formulae are defined in
     /// \verbatim
@@ -105,8 +105,8 @@ namespace spot
     bool is_eventual(const formula* f);
 #endif
 
-    /// \brief Check whether a formula is purely universal.
     /// \ingroup ltl_misc
+    /// \brief Check whether a formula is purely universal.
     ///
     /// Purely universal formulae are defined in
     /// \verbatim

src/ltlvisit/relabel.hh

@@ -28,9 +28,9 @@ namespace spot
   {
     enum relabeling_style { Abc, Pnn };
 
+    /// \ingroup ltl_rewriting
     /// \brief Relabel the atomic proposition in a formula.
     ///
-    /// \ingroup ltl_rewriting
     const formula* relabel(const formula* f, relabeling_style style);
   }
 }

src/ltlvisit/simpfg.hh

@@ -29,6 +29,7 @@ namespace spot
 {
   namespace ltl
   {
+    /// \ingroup ltl_visitor
     /// \brief Replace <code>true U f</code> and <code>false R g</code> by
     /// <code>F f</code> and <code>G g</code>.
     ///
@@ -39,7 +40,6 @@ namespace spot
     /// - false R a = G a
     /// - a W false = G a
     ///
-    /// \ingroup ltl_visitor
     class simplify_f_g_visitor : public clone_visitor
     {
       typedef clone_visitor super;
@@ -53,6 +53,7 @@ namespace spot
       virtual const formula* recurse(const formula* f);
     };
 
+    /// \ingroup ltl_rewriting
     /// \brief Replace <code>true U f</code> and <code>false R g</code> by
     /// <code>F f</code> and <code>G g</code>.
     ///
@@ -63,7 +64,6 @@ namespace spot
     /// - false R a = G a
     /// - a W false = G a
     ///
-    /// \ingroup ltl_rewriting
     const formula* simplify_f_g(const formula* f);
   }
 }

src/ltlvisit/simplify.hh

@@ -73,8 +73,8 @@ namespace spot
     // fwd declaration to hide technical details.
     class ltl_simplifier_cache;
 
-    /// \brief Rewrite or simplify \a f in various ways.
     /// \ingroup ltl_rewriting
+    /// \brief Rewrite or simplify \a f in various ways.
     class ltl_simplifier
     {
     public:

src/ltlvisit/tunabbrev.hh

@@ -30,9 +30,9 @@ namespace spot
 {
   namespace ltl
   {
+    /// \ingroup ltl_visitor
     /// \brief Clone and rewrite a formula to remove most of the
     /// abbreviated LTL and logical operators.
-    /// \ingroup ltl_visitor
     ///
     /// The rewriting performed on logical operator is
     /// the same as the one done by spot::ltl::unabbreviate_logic_visitor.

src/ltlvisit/wmunabbrev.hh

@@ -26,6 +26,7 @@ namespace spot
   {
     class formula;
 
+    /// \ingroup ltl_rewriting
     /// \brief Rewrite a formula to remove the W and M operators.
     ///
     /// This is necessary if you want to use the formula with a tool
@@ -34,7 +35,6 @@ namespace spot
     /// <code>a W b</code> is replaced by <code>b R (b | a)</code>,
     /// and <code>a M b</code> is replaced by <code>b U (b & a)</code>.
     ///
-    /// \ingroup ltl_rewriting
     const formula* unabbreviate_wm(const formula* f);
   }
 }