Fix some Doxygen errors.

* src/kripke/kripkeexplicit.hh: Reindent, and fix
some comments.
This commit is contained in:
Alexandre Duret-Lutz 2011-11-28 13:37:14 +01:00
parent 11bb4c7789
commit 799ab14300
2 changed files with 112 additions and 109 deletions

View file

@ -1,3 +1,10 @@
2011-11-28 Alexandre Duret-Lutz <adl@lrde.epita.fr>
Fix some Doxygen errors.
* src/kripke/kripkeexplicit.hh: Reindent, and fix
some comments.
2011-11-13 Alexandre Duret-Lutz <adl@lrde.epita.fr> 2011-11-13 Alexandre Duret-Lutz <adl@lrde.epita.fr>
Add more nodes when resizing BDD table. Add more nodes when resizing BDD table.

View file

@ -51,8 +51,6 @@ namespace spot
virtual int compare (const state* other) const; virtual int compare (const state* other) const;
/// \brief Hash a state /// \brief Hash a state
///
/// \FIXME For moment : Only there to can instantiate state_kripke.
virtual size_t hash() const; virtual size_t hash() const;
/// \brief Duplicate a state. /// \brief Duplicate a state.
@ -63,8 +61,8 @@ namespace spot
void add_conditions(bdd f); void add_conditions(bdd f);
/// \brief Add a new successor in the list. /// \brief Add a new successor in the list.
/// \param add_me The state to add. /// \param succ The successor state to add.
void add_succ(state_kripke*); void add_succ(state_kripke* succ);
virtual bdd virtual bdd
as_bdd() const as_bdd() const
@ -74,11 +72,13 @@ namespace spot
/// \brief Release a state. /// \brief Release a state.
/// ///
virtual void destroy() const virtual void
destroy() const
{ {
} }
virtual ~state_kripke () virtual
~state_kripke ()
{ {
} }
@ -97,8 +97,7 @@ namespace spot
class kripke_explicit_succ_iterator : public kripke_succ_iterator class kripke_explicit_succ_iterator : public kripke_succ_iterator
{ {
public: public:
kripke_explicit_succ_iterator(const state_kripke*, kripke_explicit_succ_iterator(const state_kripke*, bdd);
bdd);
~kripke_explicit_succ_iterator(); ~kripke_explicit_succ_iterator();
@ -126,64 +125,61 @@ namespace spot
bdd_dict* get_dict() const; bdd_dict* get_dict() const;
state_kripke* get_init_state() const; state_kripke* get_init_state() const;
/// \brief Allow to get an iterator on the state we passed in parameter. /// \brief Allow to get an iterator on the state we passed in
kripke_explicit_succ_iterator* succ_iter(const spot::state* local_state, /// parameter.
kripke_explicit_succ_iterator*
succ_iter(const spot::state* local_state,
const spot::state* global_state = 0, const spot::state* global_state = 0,
const tgba* global_automaton = 0) const; const tgba* global_automaton = 0) const;
/// \function state_condition /// \brief Get the condition on the state
/// \brief Get the condition on the state, designed by the adress,
/// or by his name.
bdd state_condition(const state* s) const; bdd state_condition(const state* s) const;
/// \brief Get the condition on the state
bdd state_condition(const std::string) const; bdd state_condition(const std::string) const;
/// \brief Return the name of the state. /// \brief Return the name of the state.
std::string format_state(const state*) const; std::string format_state(const state*) const;
/// \brief Create state, if it does not already exists.
/// \brief Check if the state already exist, and create it if not. ///
/// used by the parser for more simplicity. /// Used by the parser.
void add_state(std::string); void add_state(std::string);
/// \function add_transition /// \brief Add a transition between two states.
/// \brief Add a transition between two state.
/// Allow to do this with the two adress, or just the source adress,
void add_transition(std::string source, void add_transition(std::string source,
std::string dest); std::string dest);
/// \function add_conditions /// \brief Add a BDD condition to the state
/// \brief Add a condition in bdd format to the state, ///
/// name by his name or his address.
/// \param add the condition. /// \param add the condition.
/// \param on_me where add the condition. /// \param on_me where add the condition.
void add_conditions(bdd add, void add_conditions(bdd add,
std::string on_me); std::string on_me);
/// \brief Add a formula to the state corresponding to the name. /// \brief Add a formula to the state corresponding to the name.
/// \param on_me The state where add. ///
/// \param f the formula to add. /// \param f the formula to add.
/// \param on_me the state where to add.
void add_condition(const ltl::formula* f, void add_condition(const ltl::formula* f,
std::string on_me); std::string on_me);
/// \brief Return map between states and their names.
const std::map<const state_kripke*, std::string>& const std::map<const state_kripke*, std::string>&
sn_get() const; sn_get() const;
private: private:
/// \brief Add a state in the two map. /// \brief Add a state in the two maps.
void add_state(std::string, state_kripke*); void add_state(std::string, state_kripke*);
void add_conditions(bdd add, void add_conditions(bdd add,
state_kripke* on_me); state_kripke* on_me);
/// or with the two name.
void add_transition(state_kripke* source,
const state_kripke* dest);
void add_transition(std::string source, void add_transition(std::string source,
const state_kripke* dest); const state_kripke* dest);
void add_transition(state_kripke* source,
const state_kripke* dest);
bdd_dict* dict_; bdd_dict* dict_;
state_kripke* init_; state_kripke* init_;