From 2a3d638a5070ef2b4645da8bf2ea65814f04330d Mon Sep 17 00:00:00 2001 From: Alexandre Duret-Lutz Date: Wed, 17 Nov 2004 17:20:44 +0000 Subject: [PATCH] * src/misc/bareword.hh, src/misc/bddalloc.hh, src/misc/bddlt.hh, src/misc/escape.hh, src/misc/freelist.hh, src/misc/hash.hh, src/misc/hashfunc.hh, src/misc/minato.hh, src/misc/modgray.hh, src/misc/random.hh, src/misc/version.hh, src/tgba/state.hh: More Doxygen groups. --- ChangeLog | 8 ++++++++ src/misc/bareword.hh | 9 +++++++++ src/misc/bddalloc.hh | 3 ++- src/misc/bddlt.hh | 5 +++-- src/misc/escape.hh | 5 +++++ src/misc/freelist.hh | 3 ++- src/misc/hash.hh | 8 +++++--- src/misc/hashfunc.hh | 5 +++++ src/misc/minato.hh | 3 ++- src/misc/modgray.hh | 1 + src/misc/random.hh | 6 ++++++ src/misc/version.hh | 5 +++-- src/tgba/state.hh | 1 + 13 files changed, 52 insertions(+), 10 deletions(-) diff --git a/ChangeLog b/ChangeLog index fde5f192d..70ca43452 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2004-11-17 Alexandre Duret-Lutz + + * src/misc/bareword.hh, src/misc/bddalloc.hh, src/misc/bddlt.hh, + src/misc/escape.hh, src/misc/freelist.hh, src/misc/hash.hh, + src/misc/hashfunc.hh, src/misc/minato.hh, src/misc/modgray.hh, + src/misc/random.hh, src/misc/version.hh, src/tgba/state.hh: More + Doxygen groups. + 2004-11-17 Poitrenaud Denis * src/tgbaalgos/magic.hh: Fix a comment and remove se05 interface. diff --git a/src/misc/bareword.hh b/src/misc/bareword.hh index 0c8872a91..fbff174e0 100644 --- a/src/misc/bareword.hh +++ b/src/misc/bareword.hh @@ -23,7 +23,16 @@ namespace spot { + /// \addtogroup misc_tools Miscellaneous helper algorithms + /// @{ + /// \brief Whether a word is bare. + /// + /// Bare words should start with a letter or an underscore, and + /// consist solely of alphanumeric characters and underscores. bool is_bare_word(const char* str); + /// \brief Double-quote words that are not bare. + /// \see is_bare_word std::string quote_unless_bare_word(const std::string& str); + /// @} } diff --git a/src/misc/bddalloc.hh b/src/misc/bddalloc.hh index c2d145139..d63f106f4 100644 --- a/src/misc/bddalloc.hh +++ b/src/misc/bddalloc.hh @@ -28,7 +28,8 @@ namespace spot { - /// Manage ranges of variables. + /// \brief Manage ranges of variables. + /// \ingroup misc_tools class bdd_allocator: private free_list { public: diff --git a/src/misc/bddlt.hh b/src/misc/bddlt.hh index b35592022..a72105144 100644 --- a/src/misc/bddlt.hh +++ b/src/misc/bddlt.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6), +// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6), // département Systèmes Répartis Coopératifs (SRC), Université Pierre // et Marie Curie. // @@ -27,7 +27,8 @@ namespace spot { - /// Comparison functor for BDDs. + /// \brief Comparison functor for BDDs. + /// \ingroup misc_tools struct bdd_less_than : public std::binary_function { diff --git a/src/misc/escape.hh b/src/misc/escape.hh index f5eeae24e..e3754c07d 100644 --- a/src/misc/escape.hh +++ b/src/misc/escape.hh @@ -27,10 +27,15 @@ namespace spot { + /// \addtogroup misc_tools + /// @{ + /// Escape " and \ characters in \a str. std::ostream& escape_str(std::ostream& os, const std::string& str); /// Escape " and \ characters in \a str. std::string escape_str(const std::string& str); + + /// @} } #endif // SPOT_MISC_ESCAPE_HH diff --git a/src/misc/freelist.hh b/src/misc/freelist.hh index d1e512ad1..0838bfc5f 100644 --- a/src/misc/freelist.hh +++ b/src/misc/freelist.hh @@ -29,7 +29,8 @@ namespace spot { - /// Manage list of free integers. + /// \brief Manage list of free integers. + /// \ingroup misc_tools class free_list { public: diff --git a/src/misc/hash.hh b/src/misc/hash.hh index 0a0498476..bacd4cf7b 100644 --- a/src/misc/hash.hh +++ b/src/misc/hash.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6), +// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6), // département Systèmes Répartis Coopératifs (SRC), Université Pierre // et Marie Curie. // @@ -54,7 +54,8 @@ namespace spot { - /// A hash function for pointers. + /// \brief A hash function for pointers. + /// \ingroup hash_funcs template struct ptr_hash : public std::unary_function @@ -65,7 +66,8 @@ namespace spot } }; - /// A hash function for strings. + /// \brief A hash function for strings. + /// \ingroup hash_funcs struct string_hash : public Sgi::hash, public std::unary_function diff --git a/src/misc/hashfunc.hh b/src/misc/hashfunc.hh index 427940135..609e5b0b6 100644 --- a/src/misc/hashfunc.hh +++ b/src/misc/hashfunc.hh @@ -25,6 +25,10 @@ namespace spot { + /// \addtogroup hash_funcs Hashing functions + /// \ingroup misc_tools + /// @{ + /// \brief Thomas Wang's 32 bit hash function. /// /// Hash an integer amongst the integers. @@ -41,6 +45,7 @@ namespace spot key ^= (key >> 16); return key; } + /// @} } #endif // SPOT_MISC_HASHFUNC_HH diff --git a/src/misc/minato.hh b/src/misc/minato.hh index 83f830836..963e57fc1 100644 --- a/src/misc/minato.hh +++ b/src/misc/minato.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6), +// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6), // département Systèmes Répartis Coopératifs (SRC), Université Pierre // et Marie Curie. // @@ -29,6 +29,7 @@ namespace spot { /// \brief Generate an irredundant sum-of-products (ISOP) form of a /// BDD function. + /// \ingroup misc_tools /// /// This algorithm implements a derecursived version the Minato-Morreale /// algorithm presented in the following paper. diff --git a/src/misc/modgray.hh b/src/misc/modgray.hh index 0c101f754..b300f61f4 100644 --- a/src/misc/modgray.hh +++ b/src/misc/modgray.hh @@ -26,6 +26,7 @@ namespace spot { /// \brief Loopless modular mixed radix Gray code iteration. + /// \ingroup misc_tools /// /// This class is based on the loopless modular mixed radix gray /// code algorithm described in exercise 77 of "The Art of Computer diff --git a/src/misc/random.hh b/src/misc/random.hh index c9837317b..684239961 100644 --- a/src/misc/random.hh +++ b/src/misc/random.hh @@ -21,6 +21,10 @@ namespace spot { + /// \addtogroup random Random functions + /// \ingroup misc_tools + /// @{ + /// \brief Reset the seed of the pseudo-random number generator. /// /// \see drand, mrand, rrand @@ -43,4 +47,6 @@ namespace spot /// /// \see mrand, rrand, srand double drand(); + + /// @} } diff --git a/src/misc/version.hh b/src/misc/version.hh index 7205c525c..39abb8039 100644 --- a/src/misc/version.hh +++ b/src/misc/version.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2003 Laboratoire d'Informatique de Paris 6 (LIP6), +// Copyright (C) 2003, 2004 Laboratoire d'Informatique de Paris 6 (LIP6), // département Systèmes Répartis Coopératifs (SRC), Université Pierre // et Marie Curie. // @@ -24,7 +24,8 @@ namespace spot { - /// Return Spot's version. + /// \brief Return Spot's version. + /// \ingroup misc_tools const char* version(); } diff --git a/src/tgba/state.hh b/src/tgba/state.hh index 49bf5b068..90ecd7b05 100644 --- a/src/tgba/state.hh +++ b/src/tgba/state.hh @@ -125,6 +125,7 @@ namespace spot /// \brief Hash Function for \c state*. /// \ingroup tgba_essentials + /// \ingroup hash_funcs /// /// This is meant to be used as a hash functor for /// Sgi's \c hash_map whose key are of type \c state*.