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.
This commit is contained in:
Alexandre Duret-Lutz 2013-06-08 23:24:37 +02:00
parent 0ec3f7843a
commit 1ec9cebe58
91 changed files with 151 additions and 138 deletions

View file

@ -36,8 +36,8 @@ namespace spot
namespace ltl
{
/// \brief Atomic propositions.
/// \ingroup ltl_ast
/// \brief Atomic propositions.
class atomic_prop : public ref_formula
{
public:

View file

@ -32,8 +32,8 @@ namespace spot
{
namespace ltl
{
/// \brief Automaton operators.
/// \ingroup eltl_ast
/// \brief Automaton operators.
///
class automatop : public ref_formula
{

View file

@ -37,8 +37,8 @@ namespace spot
namespace ltl
{
/// \brief Binary operator.
/// \ingroup ltl_ast
/// \brief Binary operator.
class binop : public ref_formula
{
public:

View file

@ -31,8 +31,8 @@ namespace spot
namespace ltl
{
/// \brief Bounded unary operator.
/// \ingroup ltl_ast
/// \brief Bounded unary operator.
class bunop : public ref_formula
{
public:

View file

@ -29,8 +29,8 @@ namespace spot
namespace ltl
{
/// \brief A constant (True or False)
/// \ingroup ltl_ast
/// \brief A constant (True or False)
class constant : public formula
{
public:

View file

@ -62,9 +62,9 @@ namespace spot
/// \ingroup ltl_algorithm
/// \brief An LTL formula.
/// \ingroup ltl_essential
/// \ingroup ltl_ast
/// \brief An LTL formula.
///
/// The only way you can work with a formula is to
/// build a spot::ltl::visitor or spot::ltl::const_visitor.
@ -353,8 +353,8 @@ namespace spot
opkind kind_;
};
/// \brief Strict Weak Ordering for <code>const formula*</code>.
/// \ingroup ltl_essentials
/// \brief Strict Weak Ordering for <code>const formula*</code>.
///
/// This is meant to be used as a comparison functor for
/// STL \c map whose key are of type <code>const formula*</code>.
@ -394,9 +394,9 @@ namespace spot
}
};
/// \brief Hash Function for <code>const formula*</code>.
/// \ingroup ltl_essentials
/// \ingroup hash_funcs
/// \brief Hash Function for <code>const formula*</code>.
///
/// This is meant to be used as a hash functor for
/// Sgi's \c hash_map whose key are of type <code>const formula*</code>.

View file

@ -34,8 +34,8 @@ namespace spot
namespace ltl
{
/// \brief Multi-operand operators.
/// \ingroup ltl_ast
/// \brief Multi-operand operators.
class multop : public ref_formula
{
public:

View file

@ -32,8 +32,8 @@ namespace spot
namespace ltl
{
/// \brief A reference-counted LTL formula.
/// \ingroup ltl_ast
/// \brief A reference-counted LTL formula.
class ref_formula : public formula
{
protected:

View file

@ -34,8 +34,8 @@ namespace spot
namespace ltl
{
/// \brief Unary operators.
/// \ingroup ltl_ast
/// \brief Unary operators.
class unop : public ref_formula
{
public:

View file

@ -30,8 +30,8 @@ namespace spot
{
namespace ltl
{
/// \brief Formula visitor
/// \ingroup ltl_essential
/// \brief Formula visitor
///
/// Implementing visitors is the prefered way
/// to traverse a formula, since it does not