Commit 1ec9cebe authored by Alexandre Duret-Lutz's avatar Alexandre Duret-Lutz
Browse files

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.
parent 0ec3f784
......@@ -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);
......
......@@ -28,8 +28,8 @@
namespace spot
{
/// \brief Make a BFS in a spot::tgba to compute a tgba_run::steps.
/// \ingroup tgba_misc
/// \brief Make a BFS in a spot::tgba to compute a tgba_run::steps.
///
/// This class should be used to compute the shortest path
/// between a state of a spot::tgba and the first transition or
......
......@@ -24,6 +24,7 @@ namespace spot
class sba;
class tgba;
/// \ingroup tgba_misc
/// \brief Degeneralize a spot::tgba into an equivalent sba with
/// only one acceptance condition.
///
......@@ -46,7 +47,6 @@ namespace spot
/// \a a to be computed prior to its actual degeneralization.
///
/// \see tgba_sba_proxy, tgba_tba_proxy
/// \ingroup tgba_misc
sba* degeneralize(const tgba* a, bool use_z_lvl = true,
bool use_cust_acc_orders = false,
bool use_lvl_cache = true);
......
......@@ -30,8 +30,8 @@ namespace spot
class tgba;
class dotty_decorator;
/// \brief Print reachable states in dot format.
/// \ingroup tgba_io
/// \brief Print reachable states in dot format.
///
/// If \a assume_sba is set, this assumes that the automaton
/// is an SBA and use double elipse to mark accepting states.
......
......@@ -31,8 +31,8 @@ namespace spot
/// \addtogroup tgba_dotty Decorating the dot output
/// \ingroup tgba_io
/// \brief Choose state and link styles for spot::dotty_reachable.
/// \ingroup tgba_dotty
/// \brief Choose state and link styles for spot::dotty_reachable.
class dotty_decorator
{
public:
......
......@@ -27,25 +27,25 @@
namespace spot
{
/// \ingroup tgba_misc
/// \brief Build an explicit automata from all states of \a aut,
/// numbering states in bread first order as they are processed.
/// \ingroup tgba_misc
tgba_explicit_number* tgba_dupexp_bfs(const tgba* aut);
/// \ingroup tgba_misc
/// \brief Build an explicit automata from all states of \a aut,
/// numbering states in depth first order as they are processed.
/// \ingroup tgba_misc
tgba_explicit_number* tgba_dupexp_dfs(const tgba* aut);
/// \ingroup tgba_misc
/// \brief Build an explicit automata from all states of \a aut,
/// numbering states in bread first order as they are processed.
/// \ingroup tgba_misc
tgba_explicit_number*
tgba_dupexp_bfs(const tgba* aut,
std::map<const state*, const state*,
state_ptr_less_than>& relation);
/// \ingroup tgba_misc
/// \brief Build an explicit automata from all states of \a aut,
/// numbering states in depth first order as they are processed.
/// \ingroup tgba_misc
tgba_explicit_number*
tgba_dupexp_dfs(const tgba* aut,
std::map<const state*, const state*,
......
......@@ -24,8 +24,8 @@
namespace spot
{
/// \brief Build a spot::tgba_bdd_concrete from an ELTL formula.
/// \ingroup tgba_ltl
/// \brief Build a spot::tgba_bdd_concrete from an ELTL formula.
///
/// This is based on the following paper.
/// \verbatim
......
......@@ -29,8 +29,8 @@
namespace spot
{
/// \brief Print reachable states in LBTT's format.
/// \ingroup tgba_io
/// \brief Print reachable states in LBTT's format.
///
/// \param g The automata to print.
/// \param os Where to print.
......@@ -39,8 +39,8 @@ namespace spot
std::ostream& lbtt_reachable(std::ostream& os, const tgba* g,
bool sba = false);
/// \brief Read an automaton in LBTT's format
/// \ingroup tgba_io
/// \brief Read an automaton in LBTT's format
///
/// \param is The stream on which the automaton should be input.
/// \param error A string in which to write any error message.
......
......@@ -24,8 +24,8 @@
namespace spot
{
/// \brief Build a spot::taa* from an LTL formula.
/// \ingroup tgba_ltl
/// \brief Build a spot::taa* from an LTL formula.
///
/// This is based on the following.
/// \verbatim
......
......@@ -29,8 +29,8 @@
namespace spot
{
/// \brief Build a spot::tgba_explicit* from an LTL formula.
/// \ingroup tgba_ltl
/// \brief Build a spot::tgba_explicit* from an LTL formula.
///
/// This is based on the following paper.
/// \verbatim
......
......@@ -25,8 +25,8 @@
namespace spot
{
/// \brief Build a spot::tgba_bdd_concrete from an LTL formula.
/// \ingroup tgba_ltl
/// \brief Build a spot::tgba_bdd_concrete from an LTL formula.
///
/// This is based on the following paper.
/// \verbatim
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment