doxygen: improve formula documentation

* doc/Doxyfile.in: Adjust to hide SPOT_API.
* doc/mainpage.dox: Adjust like to parse_infix_psl().
* src/tl/formula.hh: Document most methods of formula,
and fix the definition of the comparisons operator.
* src/ltlparse/public.hh, src/tl/apcollect.hh, src/tl/declenv.hh,
src/tl/defaultenv.hh, src/tl/dot.hh, src/tl/environment.hh,
src/tl/length.hh, src/tl/mark.hh, src/tl/nenoform.hh, src/tl/print.hh,
src/tl/randomltl.hh, src/tl/relabel.hh, src/tl/simpfg.hh,
src/tl/simplify.hh, src/tl/unabbrev.hh: Adjust doxygen group.
This commit is contained in:
Alexandre Duret-Lutz 2015-09-29 22:59:05 +02:00
parent ca95e4d1d2
commit dcb9d7e8a8
18 changed files with 407 additions and 135 deletions

View file

@ -38,7 +38,7 @@
namespace spot
{
/// \ingroup ltl_io
/// \ingroup tl_io
/// \brief Base class for random formula generators
class SPOT_API random_formula
{
@ -105,7 +105,7 @@ namespace spot
};
/// \ingroup ltl_io
/// \ingroup tl_io
/// \brief Generate random LTL formulae.
///
/// This class recursively constructs LTL formulae of a given
@ -158,7 +158,7 @@ namespace spot
random_ltl(int size, const atomic_prop_set* ap);
};
/// \ingroup ltl_io
/// \ingroup tl_io
/// \brief Generate random Boolean formulae.
///
/// This class recursively constructs Boolean formulae of a given size.
@ -198,7 +198,7 @@ namespace spot
random_boolean(const atomic_prop_set* ap);
};
/// \ingroup ltl_io
/// \ingroup tl_io
/// \brief Generate random SERE.
///
/// This class recursively constructs SERE of a given size.
@ -241,7 +241,7 @@ namespace spot
random_boolean rb;
};
/// \ingroup ltl_io
/// \ingroup tl_io
/// \brief Generate random PSL formulae.
///
/// This class recursively constructs PSL formulae of a given size.