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:
parent
0ec3f7843a
commit
1ec9cebe58
91 changed files with 151 additions and 138 deletions
|
|
@ -23,8 +23,8 @@
|
|||
namespace spot
|
||||
{
|
||||
|
||||
/// \brief Wrap a tgba to offer information about upcoming conditions.
|
||||
/// \ingroup tgba
|
||||
/// \brief Wrap a tgba to offer information about upcoming conditions.
|
||||
///
|
||||
/// This class is a spot::tgba wrapper that simply add a new method,
|
||||
/// future_conditions(), to any spot::tgba.
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \brief A State-based Generalized Büchi Automaton.
|
||||
/// \ingroup tgba_essentials
|
||||
/// \brief A State-based Generalized Büchi Automaton.
|
||||
///
|
||||
/// An SBA is a TGBA in which the outgoing transitions of
|
||||
/// a state are either all accepting (in which case the
|
||||
|
|
|
|||
|
|
@ -33,8 +33,8 @@
|
|||
namespace spot
|
||||
{
|
||||
|
||||
/// \brief Abstract class for states.
|
||||
/// \ingroup tgba_essentials
|
||||
/// \brief Abstract class for states.
|
||||
class state
|
||||
{
|
||||
public:
|
||||
|
|
@ -98,8 +98,8 @@ namespace spot
|
|||
}
|
||||
};
|
||||
|
||||
/// \brief Strict Weak Ordering for \c state*.
|
||||
/// \ingroup tgba_essentials
|
||||
/// \brief Strict Weak Ordering for \c state*.
|
||||
///
|
||||
/// This is meant to be used as a comparison functor for
|
||||
/// STL \c map whose key are of type \c state*.
|
||||
|
|
@ -121,8 +121,8 @@ namespace spot
|
|||
}
|
||||
};
|
||||
|
||||
/// \brief An Equivalence Relation for \c state*.
|
||||
/// \ingroup tgba_essentials
|
||||
/// \brief An Equivalence Relation for \c state*.
|
||||
///
|
||||
/// This is meant to be used as a comparison functor for
|
||||
/// Sgi \c hash_map whose key are of type \c state*.
|
||||
|
|
@ -145,9 +145,9 @@ namespace spot
|
|||
}
|
||||
};
|
||||
|
||||
/// \brief Hash Function for \c state*.
|
||||
/// \ingroup tgba_essentials
|
||||
/// \ingroup hash_funcs
|
||||
/// \brief Hash Function for \c state*.
|
||||
///
|
||||
/// This is meant to be used as a hash functor for
|
||||
/// Sgi's \c hash_map whose key are of type \c state*.
|
||||
|
|
@ -177,9 +177,9 @@ namespace spot
|
|||
|
||||
inline void shared_state_deleter(state* s) { s->destroy(); }
|
||||
|
||||
/// \ingroup tgba_essentials
|
||||
/// \brief Strict Weak Ordering for \c shared_state
|
||||
/// (shared_ptr<const state*>).
|
||||
/// \ingroup tgba_essentials
|
||||
///
|
||||
/// This is meant to be used as a comparison functor for
|
||||
/// STL \c map whose key are of type \c shared_state.
|
||||
|
|
@ -203,9 +203,9 @@ namespace spot
|
|||
}
|
||||
};
|
||||
|
||||
/// \ingroup tgba_essentials
|
||||
/// \brief An Equivalence Relation for \c shared_state
|
||||
/// (shared_ptr<const state*>).
|
||||
/// \ingroup tgba_essentials
|
||||
///
|
||||
/// This is meant to be used as a comparison functor for
|
||||
/// Sgi \c hash_map whose key are of type \c shared_state.
|
||||
|
|
@ -231,9 +231,9 @@ namespace spot
|
|||
}
|
||||
};
|
||||
|
||||
/// \brief Hash Function for \c shared_state (shared_ptr<const state*>).
|
||||
/// \ingroup tgba_essentials
|
||||
/// \ingroup hash_funcs
|
||||
/// \brief Hash Function for \c shared_state (shared_ptr<const state*>).
|
||||
///
|
||||
/// This is meant to be used as a hash functor for
|
||||
/// Sgi's \c hash_map whose key are of type
|
||||
|
|
|
|||
|
|
@ -26,8 +26,8 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \brief Iterate over the successors of a state.
|
||||
/// \ingroup tgba_essentials
|
||||
/// \brief Iterate over the successors of a state.
|
||||
///
|
||||
/// This class provides the basic functionalities required to
|
||||
/// iterate over the successors of a state, as well as querying
|
||||
|
|
|
|||
|
|
@ -41,8 +41,8 @@ namespace spot
|
|||
/// \addtogroup tgba_essentials Essential TGBA types
|
||||
/// \ingroup tgba
|
||||
|
||||
/// \brief A Transition-based Generalized Büchi Automaton.
|
||||
/// \ingroup tgba_essentials
|
||||
/// \brief A Transition-based Generalized Büchi Automaton.
|
||||
///
|
||||
/// The acronym TGBA (Transition-based Generalized Büchi Automaton)
|
||||
/// was coined by Dimitra Giannakopoulou and Flavio Lerda
|
||||
|
|
|
|||
|
|
@ -29,8 +29,8 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \brief A concrete spot::tgba implemented using BDDs.
|
||||
/// \ingroup tgba_representation
|
||||
/// \brief A concrete spot::tgba implemented using BDDs.
|
||||
class tgba_bdd_concrete: public tgba
|
||||
{
|
||||
public:
|
||||
|
|
|
|||
|
|
@ -24,8 +24,8 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \brief Multiplies two spot::tgba_bdd_concrete automata.
|
||||
/// \ingroup tgba_algorithms
|
||||
/// \brief Multiplies two spot::tgba_bdd_concrete automata.
|
||||
///
|
||||
/// This function builds the resulting product as another
|
||||
/// spot::tgba_bdd_concrete automaton.
|
||||
|
|
|
|||
|
|
@ -60,8 +60,8 @@ namespace spot
|
|||
|
||||
typedef std::vector<bdd_ordered> acc_list_t;
|
||||
|
||||
/// \brief Build a complemented automaton.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
/// \brief Build a complemented automaton.
|
||||
///
|
||||
/// The construction comes from:
|
||||
/// \verbatim
|
||||
|
|
|
|||
|
|
@ -28,8 +28,8 @@
|
|||
namespace spot
|
||||
{
|
||||
|
||||
/// \brief A state for spot::tgba_product.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
/// \brief A state for spot::tgba_product.
|
||||
///
|
||||
/// This state is in fact a pair of state: the state from the left
|
||||
/// automaton and that of the right.
|
||||
|
|
|
|||
|
|
@ -29,8 +29,8 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \brief Build a complemented automaton.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
/// \brief Build a complemented automaton.
|
||||
///
|
||||
/// It creates an automaton that recognizes the
|
||||
/// negated language of \a aut.
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@
|
|||
namespace spot
|
||||
{
|
||||
|
||||
/// \ingroup tgba
|
||||
/// \brief Wrap a tgba to offer information about strongly connected
|
||||
/// components.
|
||||
/// \ingroup tgba
|
||||
///
|
||||
/// This class is a spot::tgba wrapper that simply add a new method
|
||||
/// scc_of_state() to retrieve the number of a SCC a state belongs to.
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@
|
|||
namespace spot
|
||||
{
|
||||
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
/// \brief Change the labeling-mode of spot::tgba on the fly, producing a
|
||||
/// state-based generalized Büchi automaton.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
///
|
||||
/// This class acts as a proxy in front of a spot::tgba, that should
|
||||
/// label on states on-the-fly. The result is still a spot::tgba,
|
||||
|
|
|
|||
|
|
@ -31,8 +31,8 @@
|
|||
namespace spot
|
||||
{
|
||||
|
||||
/// \brief Degeneralize a spot::tgba on the fly, producing a TBA.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
/// \brief Degeneralize a spot::tgba on the fly, producing a TBA.
|
||||
///
|
||||
/// This class acts as a proxy in front of a spot::tgba, that should
|
||||
/// be degeneralized on the fly. The result is still a spot::tgba,
|
||||
|
|
@ -124,8 +124,8 @@ namespace spot
|
|||
tgba_tba_proxy& operator=(const tgba_tba_proxy&);
|
||||
};
|
||||
|
||||
/// \brief Degeneralize a spot::tgba on the fly, producing an SBA.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
/// \brief Degeneralize a spot::tgba on the fly, producing an SBA.
|
||||
///
|
||||
/// This class acts as a proxy in front of a spot::tgba, that should
|
||||
/// be degeneralized on the fly.
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \brief A state for spot::tgba_union.
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
/// \brief A state for spot::tgba_union.
|
||||
///
|
||||
/// This state is in fact a pair.
|
||||
/// If the first member equals 0 and the second is different from 0,
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@
|
|||
|
||||
namespace spot
|
||||
{
|
||||
/// \brief Complement a weak deterministic Büchi automaton
|
||||
/// \ingroup tgba_on_the_fly_algorithms
|
||||
/// \brief Complement a weak deterministic Büchi automaton
|
||||
/// \param aut a weak deterministic Büchi automaton to complement
|
||||
/// \return a new automaton that recognizes the complement language
|
||||
tgba* wdba_complement(const tgba* aut);
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue