Commit dcb9d7e8 authored by Alexandre Duret-Lutz's avatar Alexandre Duret-Lutz
Browse files

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.
parent ca95e4d1
...@@ -1970,7 +1970,7 @@ ENABLE_PREPROCESSING = YES ...@@ -1970,7 +1970,7 @@ ENABLE_PREPROCESSING = YES
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and # the macro expansion is limited to the macros specified with the PREDEFINED and
...@@ -2010,7 +2010,7 @@ INCLUDE_FILE_PATTERNS = ...@@ -2010,7 +2010,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator. # recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = PREDEFINED = SPOT_API=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The # tag can be used to specify a list of macro names that should be expanded. The
......
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
/// \section pointers Handy starting points /// \section pointers Handy starting points
/// ///
/// \li spot::formula Base class for an LTL or PSL formula. /// \li spot::formula Base class for an LTL or PSL formula.
/// \li spot::parse_infix_psl Parsing a text string into a /// \li spot::parse_infix_psl() Parsing a text string into a
/// spot::formula. /// spot::formula.
/// \li spot::twa Base class for Transition-based /// \li spot::twa Base class for Transition-based
/// ω-Automata. /// ω-Automata.
......
...@@ -32,7 +32,7 @@ ...@@ -32,7 +32,7 @@
namespace spot namespace spot
{ {
/// \addtogroup ltl_io /// \addtogroup tl_io
/// @{ /// @{
#ifndef SWIG #ifndef SWIG
......
...@@ -29,7 +29,7 @@ ...@@ -29,7 +29,7 @@
namespace spot namespace spot
{ {
/// \addtogroup ltl_misc /// \addtogroup tl_misc
/// @{ /// @{
/// Set of atomic propositions. /// Set of atomic propositions.
......
...@@ -29,7 +29,7 @@ ...@@ -29,7 +29,7 @@
namespace spot namespace spot
{ {
/// \ingroup ltl_environment /// \ingroup tl_environment
/// \brief A declarative environment. /// \brief A declarative environment.
/// ///
/// This environment recognizes all atomic propositions /// This environment recognizes all atomic propositions
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
namespace spot namespace spot
{ {
/// \ingroup ltl_environment /// \ingroup tl_environment
/// \brief A laxist environment. /// \brief A laxist environment.
/// ///
/// This environment recognizes all atomic propositions. /// This environment recognizes all atomic propositions.
......
...@@ -26,7 +26,7 @@ ...@@ -26,7 +26,7 @@
namespace spot namespace spot
{ {
/// \ingroup ltl_io /// \ingroup tl_io
/// \brief Write a formula tree using dot's syntax. /// \brief Write a formula tree using dot's syntax.
/// \param os The stream where it should be output. /// \param os The stream where it should be output.
/// \param f The formula to translate. /// \param f The formula to translate.
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
namespace spot namespace spot
{ {
/// \ingroup ltl_essential /// \ingroup tl_environment
/// \brief An environment that describes atomic propositions. /// \brief An environment that describes atomic propositions.
class environment class environment
{ {
......
This diff is collapsed.
...@@ -26,7 +26,7 @@ ...@@ -26,7 +26,7 @@
namespace spot namespace spot
{ {
/// \ingroup ltl_misc /// \ingroup tl_misc
/// \brief Compute the length of a formula. /// \brief Compute the length of a formula.
/// ///
/// The length of a formula is the number of atomic propositions, /// The length of a formula is the number of atomic propositions,
...@@ -40,7 +40,7 @@ namespace spot ...@@ -40,7 +40,7 @@ namespace spot
SPOT_API SPOT_API
int length(formula f); int length(formula f);
/// \ingroup ltl_misc /// \ingroup tl_misc
/// \brief Compute the length of a formula, squashing Boolean formulae /// \brief Compute the length of a formula, squashing Boolean formulae
/// ///
/// This is similar to spot::length(), except all Boolean /// This is similar to spot::length(), except all Boolean
......
...@@ -27,7 +27,7 @@ namespace spot ...@@ -27,7 +27,7 @@ namespace spot
class mark_tools final class mark_tools final
{ {
public: public:
/// \ingroup ltl_rewriting /// \ingroup tl_rewriting
/// \brief Mark operators NegClosure and EConcat. /// \brief Mark operators NegClosure and EConcat.
/// ///
/// \param f The formula to rewrite. /// \param f The formula to rewrite.
......
...@@ -26,7 +26,7 @@ ...@@ -26,7 +26,7 @@
namespace spot namespace spot
{ {
/// \ingroup ltl_rewriting /// \ingroup tl_rewriting
/// \brief Build the negative normal form of \a f. /// \brief Build the negative normal form of \a f.
/// ///
/// All negations of the formula are pushed in front of the /// All negations of the formula are pushed in front of the
......
...@@ -27,7 +27,7 @@ ...@@ -27,7 +27,7 @@
namespace spot namespace spot
{ {
/// \addtogroup ltl_io /// \addtogroup tl_io
/// @{ /// @{
/// \brief Output a PSL formula as a string which is parsable. /// \brief Output a PSL formula as a string which is parsable.
......
...@@ -38,7 +38,7 @@ ...@@ -38,7 +38,7 @@
namespace spot namespace spot
{ {
/// \ingroup ltl_io /// \ingroup tl_io
/// \brief Base class for random formula generators /// \brief Base class for random formula generators
class SPOT_API random_formula class SPOT_API random_formula
{ {
...@@ -105,7 +105,7 @@ namespace spot ...@@ -105,7 +105,7 @@ namespace spot
}; };
/// \ingroup ltl_io /// \ingroup tl_io
/// \brief Generate random LTL formulae. /// \brief Generate random LTL formulae.
/// ///
/// This class recursively constructs LTL formulae of a given /// This class recursively constructs LTL formulae of a given
...@@ -158,7 +158,7 @@ namespace spot ...@@ -158,7 +158,7 @@ namespace spot
random_ltl(int size, const atomic_prop_set* ap); random_ltl(int size, const atomic_prop_set* ap);
}; };
/// \ingroup ltl_io /// \ingroup tl_io
/// \brief Generate random Boolean formulae. /// \brief Generate random Boolean formulae.
/// ///
/// This class recursively constructs Boolean formulae of a given size. /// This class recursively constructs Boolean formulae of a given size.
...@@ -198,7 +198,7 @@ namespace spot ...@@ -198,7 +198,7 @@ namespace spot
random_boolean(const atomic_prop_set* ap); random_boolean(const atomic_prop_set* ap);
}; };
/// \ingroup ltl_io /// \ingroup tl_io
/// \brief Generate random SERE. /// \brief Generate random SERE.
/// ///
/// This class recursively constructs SERE of a given size. /// This class recursively constructs SERE of a given size.
...@@ -241,7 +241,7 @@ namespace spot ...@@ -241,7 +241,7 @@ namespace spot
random_boolean rb; random_boolean rb;
}; };
/// \ingroup ltl_io /// \ingroup tl_io
/// \brief Generate random PSL formulae. /// \brief Generate random PSL formulae.
/// ///
/// This class recursively constructs PSL formulae of a given size. /// This class recursively constructs PSL formulae of a given size.
......
...@@ -29,7 +29,7 @@ namespace spot ...@@ -29,7 +29,7 @@ namespace spot
typedef std::map<formula, formula> relabeling_map; typedef std::map<formula, formula> relabeling_map;
/// \ingroup ltl_rewriting /// \ingroup tl_rewriting
/// \brief Relabel the atomic propositions in a formula. /// \brief Relabel the atomic propositions in a formula.
/// ///
/// If \a m is non-null, it is filled with correspondence /// If \a m is non-null, it is filled with correspondence
...@@ -39,7 +39,7 @@ namespace spot ...@@ -39,7 +39,7 @@ namespace spot
relabeling_map* m = nullptr); relabeling_map* m = nullptr);
/// \ingroup ltl_rewriting /// \ingroup tl_rewriting
/// \brief Relabel Boolean subexpressions in a formula using /// \brief Relabel Boolean subexpressions in a formula using
/// atomic propositions. /// atomic propositions.
/// ///
......
...@@ -26,7 +26,7 @@ ...@@ -26,7 +26,7 @@
namespace spot namespace spot
{ {
/// \ingroup ltl_rewriting /// \ingroup tl_rewriting
/// \brief Replace <code>true U f</code> and <code>false R g</code> by /// \brief Replace <code>true U f</code> and <code>false R g</code> by
/// <code>F f</code> and <code>G g</code>. /// <code>F f</code> and <code>G g</code>.
/// ///
......
...@@ -92,7 +92,7 @@ namespace spot ...@@ -92,7 +92,7 @@ namespace spot
// fwd declaration to hide technical details. // fwd declaration to hide technical details.
class ltl_simplifier_cache; class ltl_simplifier_cache;
/// \ingroup ltl_rewriting /// \ingroup tl_rewriting
/// \brief Rewrite or simplify \a f in various ways. /// \brief Rewrite or simplify \a f in various ways.
class SPOT_API ltl_simplifier class SPOT_API ltl_simplifier
{ {
......
...@@ -26,7 +26,7 @@ namespace spot ...@@ -26,7 +26,7 @@ namespace spot
{ {
constexpr const char* default_unabbrev_string = "eFGiMW^"; constexpr const char* default_unabbrev_string = "eFGiMW^";
/// \ingroup ltl_rewriting /// \ingroup tl_rewriting
/// \brief Clone and rewrite a formula to remove specified operators /// \brief Clone and rewrite a formula to remove specified operators
/// logical operators. /// logical operators.
class SPOT_API unabbreviator final class SPOT_API unabbreviator final
...@@ -56,7 +56,7 @@ namespace spot ...@@ -56,7 +56,7 @@ namespace spot
formula run(formula in); formula run(formula in);
}; };
/// \ingroup ltl_rewriting /// \ingroup tl_rewriting
/// \brief Clone and rewrite a formula to remove specified operators /// \brief Clone and rewrite a formula to remove specified operators
/// logical operators. /// logical operators.
/// ///
......
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