Commit 8839f50a authored by Alexandre Duret-Lutz's avatar Alexandre Duret-Lutz

rename Doxygen groups

Automatic mass renaming.

* src/dstarparse/public.hh, src/hoaparse/public.hh,
src/kripke/fairkripke.hh, src/kripke/kripkeprint.hh,
src/tgba/bdddict.hh, src/tgba/tgba.hh, src/tgba/tgbamask.cc,
src/tgba/tgbamask.hh, src/tgba/tgbaproduct.hh, src/tgba/tgbaproxy.hh,
src/tgba/tgbasafracomplement.cc, src/tgba/tgbasafracomplement.hh,
src/tgbaalgos/are_isomorphic.hh, src/tgbaalgos/bfssteps.hh,
src/tgbaalgos/canonicalize.hh, src/tgbaalgos/degen.hh,
src/tgbaalgos/dotty.hh, src/tgbaalgos/dupexp.hh,
src/tgbaalgos/emptiness.hh, src/tgbaalgos/hoa.hh,
src/tgbaalgos/isdet.hh, src/tgbaalgos/isweakscc.hh,
src/tgbaalgos/lbtt.hh, src/tgbaalgos/ltl2taa.hh,
src/tgbaalgos/ltl2tgba_fm.hh, src/tgbaalgos/minimize.hh,
src/tgbaalgos/neverclaim.hh, src/tgbaalgos/postproc.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/simulation.hh, src/tgbaalgos/stats.hh,
src/tgbaalgos/stripacc.hh, src/tgbaalgos/translate.hh:
Rename all documention group starting with tgba_ as
group starting with twa_.
parent 03f78ee8
......@@ -30,7 +30,7 @@
namespace spot
{
/// \addtogroup tgba_io
/// \addtogroup twa_io
/// @{
/// \brief A parse diagnostic with its location.
......
......@@ -30,7 +30,7 @@
namespace spot
{
/// \addtogroup tgba_io
/// \addtogroup twa_io
/// @{
#ifndef SWIG
......
......@@ -23,7 +23,7 @@
#include "fwd.hh"
/// \addtogroup kripke Kripke Structures
/// \ingroup tgba
/// \ingroup twa
namespace spot
{
......
......@@ -26,7 +26,7 @@
namespace spot
{
/// \ingroup tgba_io
/// \ingroup twa_io
/// \brief Save the reachable part of Kripke structure in text format.
///
/// The states will be named with the value returned by the
......@@ -38,7 +38,7 @@ namespace spot
SPOT_API std::ostream&
kripke_save_reachable(std::ostream& os, const const_kripke_ptr& k);
/// \ingroup tgba_io
/// \ingroup twa_io
/// \brief Save the reachable part of Kripke structure in text format.
///
/// States will be renumbered with sequential number. This is much
......
......@@ -36,7 +36,7 @@ namespace spot
/// \brief Private data for bdd_dict.
class bdd_dict_priv;
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief Map BDD variables to formulae.
///
/// The BDD library uses integers to designate Boolean variables in
......
......@@ -35,7 +35,7 @@
namespace spot
{
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief Abstract class for states.
class SPOT_API state
{
......@@ -100,7 +100,7 @@ namespace spot
}
};
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief Strict Weak Ordering for \c state*.
///
/// This is meant to be used as a comparison functor for
......@@ -122,7 +122,7 @@ namespace spot
}
};
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief An Equivalence Relation for \c state*.
///
/// This is meant to be used as a comparison functor for
......@@ -145,7 +145,7 @@ namespace spot
}
};
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \ingroup hash_funcs
/// \brief Hash Function for \c state*.
///
......@@ -173,7 +173,7 @@ namespace spot
state_ptr_hash, state_ptr_equal> state_set;
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief Render state pointers unique via a hash table.
class SPOT_API state_unicity_table
{
......@@ -238,7 +238,7 @@ namespace spot
inline void shared_state_deleter(state* s) { s->destroy(); }
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief Strict Weak Ordering for \c shared_state
/// (shared_ptr<const state*>).
///
......@@ -262,7 +262,7 @@ namespace spot
}
};
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief An Equivalence Relation for \c shared_state
/// (shared_ptr<const state*>).
///
......@@ -288,7 +288,7 @@ namespace spot
}
};
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \ingroup hash_funcs
/// \brief Hash Function for \c shared_state (shared_ptr<const state*>).
///
......@@ -318,7 +318,7 @@ namespace spot
state_shared_ptr_hash,
state_shared_ptr_equal> shared_state_set;
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief Iterate over the successors of a state.
///
/// This class provides the basic functionalities required to
......@@ -441,10 +441,10 @@ namespace spot
/// algorithms that work on spot::twa are \ref tgba_algorithms
/// "listed separately".
/// \addtogroup tgba_essentials Essential TωA types
/// \addtogroup twa_essentials Essential TωA types
/// \ingroup twa
/// \ingroup tgba_essentials
/// \ingroup twa_essentials
/// \brief A Transition-based ω-Automaton.
///
/// The acronym TωA stands for Transition-based ω-automaton.
......@@ -845,27 +845,27 @@ namespace spot
};
/// \addtogroup tgba_representation TGBA representations
/// \addtogroup twa_representation TGBA representations
/// \ingroup twa
/// \addtogroup tgba_algorithms TGBA algorithms
/// \addtogroup twa_algorithms TGBA algorithms
/// \ingroup twa
/// \addtogroup tgba_on_the_fly_algorithms TGBA on-the-fly algorithms
/// \ingroup tgba_algorithms
/// \addtogroup twa_on_the_fly_algorithms TGBA on-the-fly algorithms
/// \ingroup twa_algorithms
/// \addtogroup tgba_io Input/Output of TGBA
/// \ingroup tgba_algorithms
/// \addtogroup twa_io Input/Output of TGBA
/// \ingroup twa_algorithms
/// \addtogroup tgba_ltl Translating LTL formulae into TGBA
/// \ingroup tgba_algorithms
/// \addtogroup twa_ltl Translating LTL formulae into TGBA
/// \ingroup twa_algorithms
/// \addtogroup tgba_generic Algorithm patterns
/// \ingroup tgba_algorithms
/// \addtogroup twa_generic Algorithm patterns
/// \ingroup twa_algorithms
/// \addtogroup tgba_reduction TGBA simplifications
/// \ingroup tgba_algorithms
/// \addtogroup twa_reduction TGBA simplifications
/// \ingroup twa_algorithms
/// \addtogroup tgba_misc Miscellaneous algorithms on TGBA
/// \ingroup tgba_algorithms
/// \addtogroup twa_misc Miscellaneous algorithms on TGBA
/// \ingroup twa_algorithms
}
......@@ -76,7 +76,7 @@ namespace spot
transitions::const_iterator it_;
};
/// \ingroup tgba_on_the_fly_algorithms
/// \ingroup twa_on_the_fly_algorithms
/// \brief A masked TGBA (abstract).
///
/// Ignores some states from a TGBA. What state are preserved or
......
......@@ -25,7 +25,7 @@
namespace spot
{
/// \ingroup tgba_on_the_fly_algorithms
/// \ingroup twa_on_the_fly_algorithms
/// \brief Mask a TGBA, keeping a given set of states.
///
/// Mask the TGBA \a to_mask, keeping only the
......@@ -36,7 +36,7 @@ namespace spot
const state_set& to_keep,
const state* init = 0);
/// \ingroup tgba_on_the_fly_algorithms
/// \ingroup twa_on_the_fly_algorithms
/// \brief Mask a TGBA, rejecting a given set of states.
///
/// Mask the TGBA \a to_mask, keeping only the states that are not
......@@ -48,7 +48,7 @@ namespace spot
const state* init = 0);
/// \ingroup tgba_on_the_fly_algorithms
/// \ingroup twa_on_the_fly_algorithms
/// \brief Mask a TGBA, rejecting some acceptance set of transitions.
///
/// This will ignore all transitions that have the TO_IGNORE
......
......@@ -28,7 +28,7 @@
namespace spot
{
/// \ingroup tgba_on_the_fly_algorithms
/// \ingroup twa_on_the_fly_algorithms
/// \brief A state for spot::twa_product.
///
/// This state is in fact a pair of state: the state from the left
......
......@@ -23,7 +23,7 @@
namespace spot
{
/// \ingroup tgba_on_the_fly_algorithms
/// \ingroup twa_on_the_fly_algorithms
/// \brief A TGBA proxy.
///
/// This implements a simple proxy to an existing
......
......@@ -827,7 +827,7 @@ namespace spot
// state_complement
/// States used by spot::tgba_safra_complement.
/// \ingroup tgba_representation
/// \ingroup twa_representation
class state_complement : public state
{
public:
......@@ -954,7 +954,7 @@ namespace spot
}
/// Successor iterators used by spot::tgba_safra_complement.
/// \ingroup tgba_representation
/// \ingroup twa_representation
class tgba_safra_complement_succ_iterator: public twa_succ_iterator
{
public:
......
......@@ -29,7 +29,7 @@
namespace spot
{
/// \ingroup tgba_on_the_fly_algorithms
/// \ingroup twa_on_the_fly_algorithms
/// \brief Build a complemented automaton.
///
/// It creates an automaton that recognizes the
......
......@@ -30,7 +30,7 @@ namespace spot
public:
isomorphism_checker(const const_twa_graph_ptr ref);
/// \ingroup tgba_misc
/// \ingroup twa_misc
/// \brief Check whether an automaton is isomorphic to the one passed to
/// the constructor.
///
......
......@@ -27,7 +27,7 @@
namespace spot
{
/// \ingroup tgba_misc
/// \ingroup twa_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
......
......@@ -23,7 +23,7 @@
namespace spot
{
/// \ingroup tgba_misc
/// \ingroup twa_misc
/// \brief Reorder the states and transitions of aut in a way that will be the
/// same for every isomorphic automata.
SPOT_API twa_graph_ptr canonicalize(twa_graph_ptr aut);
......
......@@ -23,7 +23,7 @@
namespace spot
{
/// \ingroup tgba_misc
/// \ingroup twa_misc
/// \brief Degeneralize a spot::tgba into an equivalent sba with
/// only one acceptance condition.
///
......
......@@ -28,7 +28,7 @@
namespace spot
{
/// \ingroup tgba_io
/// \ingroup twa_io
/// \brief Print reachable states in dot format.
///
/// If \a assume_sba is set, this assumes that the automaton
......
......@@ -29,12 +29,12 @@
namespace spot
{
/// \ingroup tgba_misc
/// \ingroup twa_misc
/// \brief Build an explicit automaton from all states of \a aut,
/// numbering states in bread first order as they are processed.
SPOT_API twa_graph_ptr
tgba_dupexp_bfs(const const_twa_ptr& aut, twa::prop_set p);
/// \ingroup tgba_misc
/// \ingroup twa_misc
/// \brief Build an explicit automaton from all states of \a aut,
/// numbering states in depth first order as they are processed.
SPOT_API twa_graph_ptr
......
......@@ -37,7 +37,7 @@ namespace spot
typedef std::shared_ptr<const tgba_run> const_tgba_run_ptr;
/// \addtogroup emptiness_check Emptiness-checks
/// \ingroup tgba_algorithms
/// \ingroup twa_algorithms
///
/// All emptiness-check algorithms follow the same interface.
/// Basically once you have constructed an instance of
......@@ -258,7 +258,7 @@ namespace spot
/// \ingroup emptiness_check
/// \addtogroup tgba_run TGBA runs and supporting functions
/// \addtogroup twa_run TGBA runs and supporting functions
/// \ingroup emptiness_check
/// @{
......
......@@ -25,7 +25,7 @@
namespace spot
{
/// \ingroup tgba_io
/// \ingroup twa_io
/// \brief Print reachable states in Hanoi Omega Automata format.
///
/// \param os The output stream to print on.
......
......@@ -23,7 +23,7 @@
namespace spot
{
/// \addtogroup tgba_misc
/// \addtogroup twa_misc
/// @{
/// \brief Count the number of non-deterministic states in \a aut.
......
......@@ -23,7 +23,7 @@
namespace spot
{
/// \addtogroup tgba_misc
/// \addtogroup twa_misc
/// @{
/// \brief Whether the SCC number \a scc in \a map is inherently
......
......@@ -27,7 +27,7 @@
namespace spot
{
/// \ingroup tgba_io
/// \ingroup twa_io
/// \brief Print reachable states in LBTT's format.
///
/// \param g The automata to print.
......
......@@ -24,7 +24,7 @@
namespace spot
{
/// \ingroup tgba_ltl
/// \ingroup twa_ltl
/// \brief Build a spot::taa* from an LTL formula.
///
/// This is based on the following.
......
......@@ -29,7 +29,7 @@
namespace spot
{
/// \ingroup tgba_ltl
/// \ingroup twa_ltl
/// \brief Build a spot::twa_graph_ptr from an LTL formula.
///
/// This is based on the following paper.
......
......@@ -24,7 +24,7 @@
namespace spot
{
/// \addtogroup tgba_reduction
/// \addtogroup twa_reduction
/// @{
/// \brief Construct a minimal deterministic monitor.
......
......@@ -28,7 +28,7 @@
namespace spot
{
/// \ingroup tgba_io
/// \ingroup twa_io
/// \brief Print reachable states in Spin never claim format.
///
/// \param os The output stream to print on.
......
......@@ -25,7 +25,7 @@ namespace spot
{
class option_map;
/// \addtogroup tgba_reduction
/// \addtogroup twa_reduction
/// @{
/// \brief Wrap TGBA/BA/Monitor post-processing algorithms in an
......
......@@ -42,7 +42,7 @@ namespace spot
};
/// \ingroup tgba_misc
/// \ingroup twa_misc
/// \brief Build a deterministic automaton, ignoring acceptance conditions.
///
/// This create a deterministic automaton that recognizes the
......
......@@ -31,7 +31,7 @@ namespace spot
{
struct tgba_run;
/// \ingroup tgba_run
/// \ingroup twa_run
/// \brief Project a tgba_run on a tgba.
///
/// If a tgba_run has been generated on a product, or any other
......
......@@ -29,7 +29,7 @@
namespace spot
{
/// \ingroup tgba_misc
/// \ingroup twa_misc
/// \brief Construct a tgba randomly.
///
/// \param n The number of states wanted in the automata (>0). All states
......
......@@ -29,7 +29,7 @@
namespace spot
{
/// \ingroup tgba_generic
/// \ingroup twa_generic
/// \brief Iterate over all reachable states of a spot::tgba.
class SPOT_API tgba_reachable_iterator
{
......@@ -95,7 +95,7 @@ namespace spot
seen_map seen; ///< States already seen.
};
/// \ingroup tgba_generic
/// \ingroup twa_generic
/// \brief An implementation of spot::tgba_reachable_iterator that browses
/// states breadth first.
class SPOT_API tgba_reachable_iterator_breadth_first :
......@@ -111,7 +111,7 @@ namespace spot
std::deque<const state*> todo; ///< A queue of states yet to explore.
};
/// \ingroup tgba_generic
/// \ingroup twa_generic
/// \brief Iterate over all states of an automaton using a DFS.
class SPOT_API tgba_reachable_iterator_depth_first
{
......@@ -177,7 +177,7 @@ namespace spot
virtual void pop();
};
/// \ingroup tgba_generic
/// \ingroup twa_generic
/// \brief Iterate over all states of an automaton using a DFS.
///
/// This variant also maintains a set of states that are on the DFS
......
......@@ -28,7 +28,7 @@
namespace spot
{
/// \ingroup tgba_run
/// \ingroup twa_run
/// \brief Reduce an accepting run.
///
/// Return a run which is accepting for \a a and that is no longer
......
......@@ -31,7 +31,7 @@ namespace spot
{
struct tgba_run;
/// \ingroup tgba_run
/// \ingroup twa_run
/// \brief Replay a tgba_run on a tgba.
///
/// This is similar to print_tgba_run(), except that the run is
......
......@@ -24,7 +24,7 @@
namespace spot
{
/// \addtogroup tgba_reduction
/// \addtogroup twa_reduction
/// @{
/// @{
......
......@@ -29,7 +29,7 @@
namespace spot
{
/// \addtogroup tgba_misc
/// \addtogroup twa_misc
/// @{
struct SPOT_API tgba_statistics
......
......@@ -23,7 +23,7 @@
namespace spot
{
/// \ingroup tgba_misc
/// \ingroup twa_misc
/// \brief Remove all acceptance sets from a twa_graph.
///
/// This is equivalent to marking all states/transitions as accepting.
......
......@@ -24,7 +24,7 @@
namespace spot
{
/// \ingroup tgba_ltl
/// \ingroup twa_ltl
/// \brief Translate an LTL formula into an optimized spot::tgba.
///
/// This class implements a three-step translation:
......
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