alarsyo/spot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

More Doxygen fixes.

Browse source 
* src/sabaalgos/sabareachiter.hh (process_link): Document argument SI.
* src/eltlparse/public.hh (format_parse_errors): Remove the
non-existing eltl_string argument from the description.
(parse_file): Fix name of parameters in documentation.
This commit is contained in:
Alexandre Duret-Lutz 2010-01-31 20:57:02 +01:00
parent 5b87fa628d
commit 34728dca52
3 changed files with 13 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
ChangeLog
View file

@ -1,3 +1,12 @@
2010-01-31 Alexandre Duret-Lutz <adl@lrde.epita.fr>
More Doxygen fixes.
* src/sabaalgos/sabareachiter.hh (process_link): Document argument SI.
* src/eltlparse/public.hh (format_parse_errors): Remove the
non-existing eltl_string argument from the description.
(parse_file): Fix name of parameters in documentation.
2010-01-31 Alexandre Duret-Lutz <adl@lrde.epita.fr> 2010-01-31 Alexandre Duret-Lutz <adl@lrde.epita.fr>
Build doxygen pictures with libgd to reduce their size. Build doxygen pictures with libgd to reduce their size.

3
src/eltlparse/public.hh
View file

@ -55,7 +55,7 @@ namespace spot
typedef std::list<parse_error> parse_error_list; typedef std::list<parse_error> parse_error_list;
/// \brief Build a formula from a text file. /// \brief Build a formula from a text file.
/// \param name The name of the file to parse. /// \param filename The name of the file to parse.
/// \param error_list A list that will be filled with /// \param error_list A list that will be filled with
/// parse errors that occured during parsing. /// parse errors that occured during parsing.
/// \param env The environment into which parsing should take place. /// \param env The environment into which parsing should take place.
@ -86,7 +86,6 @@ namespace spot
/// \brief Format diagnostics produced by spot::eltl::parse. /// \brief Format diagnostics produced by spot::eltl::parse.
/// \param os Where diagnostics should be output. /// \param os Where diagnostics should be output.
/// \param eltl_string The string that were parsed.
/// \param error_list The error list filled by spot::eltl::parse while /// \param error_list The error list filled by spot::eltl::parse while
/// parsing \a eltl_string. /// parsing \a eltl_string.
/// \return \c true iff any diagnostic was output. /// \return \c true iff any diagnostic was output.

4
src/sabaalgos/sabareachiter.hh
View file

@ -1,4 +1,4 @@
// Copyright (C) 2009 Laboratoire de Recherche et Développement // Copyright (C) 2009, 2010 Laboratoire de Recherche et Développement
// de l'Epita (LRDE). // de l'Epita (LRDE).
// //
// This file is part of Spot, a model checking library. // This file is part of Spot, a model checking library.
@ -93,6 +93,8 @@ namespace spot
/// \param sc The spot::saba_state_conjunction positionned on the current /// \param sc The spot::saba_state_conjunction positionned on the current
/// conjunction. /// conjunction.
/// \param sc_id An unique number for the this transition assigned to \a sc. /// \param sc_id An unique number for the this transition assigned to \a sc.
/// \param si The spot::saba_succ_iterator positionned on the current
/// transition.
/// ///
/// The in_s and out_s states are owned by the /// The in_s and out_s states are owned by the
/// spot::saba_reachable_iterator instance and destroyed when the /// spot::saba_reachable_iterator instance and destroyed when the