* 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

@@ -1,3 +1,11 @@
+2004-11-17  Alexandre Duret-Lutz  <adl@src.lip6.fr>
+
+	* 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  <denis@src.lip6.fr>
 
 	* src/tgbaalgos/magic.hh: Fix a comment and remove se05 interface.

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);
+  /// @}
 }

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:

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<const bdd&, const bdd&, bool>
   {

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

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:

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 <class T>
   struct ptr_hash :
     public std::unary_function<const T*, size_t>
@@ -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<const char*>,
     public std::unary_function<const std::string&, size_t>

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

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.

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

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();
+
+  /// @}
 }

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();
 }
 

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*.