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

@ -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

View file

@ -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);

View file

@ -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.

View file

@ -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:

View file

@ -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*,

View file

@ -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

View file

@ -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.

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -28,8 +28,8 @@
namespace spot
{
/// \brief Print reachable states in Spin never claim format.
/// \ingroup tgba_io
/// \brief Print reachable states in Spin never claim format.
///
/// \param os The output stream to print on.
/// \param g The (state-based degeneralized) automaton to output.

View file

@ -76,8 +76,8 @@ namespace spot
};
/// \brief Build a deterministic automaton, ignoring acceptance conditions.
/// \ingroup tgba_misc
/// \brief Build a deterministic automaton, ignoring acceptance conditions.
///
/// This create a deterministic automaton that recognizes the
/// same language as \a aut would if its acceptance conditions

View file

@ -27,8 +27,8 @@ namespace spot
struct tgba_run;
class tgba;
/// \brief Project a tgba_run on a tgba.
/// \ingroup tgba_run
/// \brief Project a tgba_run on a tgba.
///
/// If a tgba_run has been generated on a product, or any other
/// on-the-fly algorithm with tgba operands,

View file

@ -30,8 +30,8 @@ namespace spot
class bdd_dict;
class tgba;
/// \brief Construct a tgba randomly.
/// \ingroup tgba_misc
/// \brief Construct a tgba randomly.
///
/// \param n The number of states wanted in the automata (>0). All states
/// will be connected, and there will be no dead state.

View file

@ -29,8 +29,8 @@
namespace spot
{
/// \brief Iterate over all reachable states of a spot::tgba.
/// \ingroup tgba_generic
/// \brief Iterate over all reachable states of a spot::tgba.
class tgba_reachable_iterator
{
public:
@ -95,9 +95,9 @@ namespace spot
seen_map seen; ///< States already seen.
};
/// \ingroup tgba_generic
/// \brief An implementation of spot::tgba_reachable_iterator that browses
/// states depth first.
/// \ingroup tgba_generic
class tgba_reachable_iterator_depth_first : public tgba_reachable_iterator
{
public:
@ -110,9 +110,9 @@ namespace spot
std::stack<const state*> todo; ///< A stack of states yet to explore.
};
/// \ingroup tgba_generic
/// \brief An implementation of spot::tgba_reachable_iterator that browses
/// states breadth first.
/// \ingroup tgba_generic
class tgba_reachable_iterator_breadth_first : public tgba_reachable_iterator
{
public:

View file

@ -27,8 +27,8 @@ namespace spot
class tgba;
struct tgba_run;
/// \brief Reduce an accepting run.
/// \ingroup tgba_run
/// \brief Reduce an accepting run.
///
/// Return a run which is accepting for \a and that is no longer
/// that \a org.

View file

@ -27,8 +27,8 @@ namespace spot
struct tgba_run;
class tgba;
/// \brief Replay a tgba_run on a tgba.
/// \ingroup tgba_run
/// \brief Replay a tgba_run on a tgba.
///
/// This is similar to print_tgba_run(), except that the run is
/// actually replayed on the automaton while it is printed. Doing

View file

@ -30,8 +30,8 @@
namespace spot
{
/// \brief Highlight a spot::tgba_run on a spot::tgba.
/// \ingroup tgba_dotty
/// \brief Highlight a spot::tgba_run on a spot::tgba.
///
/// An instance of this class can be passed to spot::dotty_reachable.
class tgba_run_dotty_decorator: public dotty_decorator

View file

@ -25,8 +25,8 @@
namespace spot
{
/// \brief Save reachable states in text format.
/// \ingroup tgba_io
/// \brief Save reachable states in text format.
std::ostream& tgba_save_reachable(std::ostream& os, const tgba* g);
}

View file

@ -24,10 +24,10 @@
namespace spot
{
/// \ingroup tgba_misc
/// \brief Duplicate automaton \a a, removing all acceptance sets.
///
/// This is equivalent to marking all states/transitions as accepting.
/// \ingroup tgba_misc
sba_explicit_number* strip_acceptance(const tgba* a);
}

View file

@ -25,8 +25,8 @@
namespace spot
{
/// \brief Translate an LTL formula into an optimized spot::tgba.
/// \ingroup tgba_ltl
/// \brief Translate an LTL formula into an optimized spot::tgba.
///
/// This class implements a three-step translation:
/// - syntactic simplification of the formula