Changeset 314:2cc60866a0c9 in lemon-1.2 for lemon/bits/base_extender.h

Timestamp:

10/09/08 13:27:35 (15 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Doc reorganization + improvements

• Reorganize several tools (move them to other modules).
• Add new module for map concepts.
• Remove the doc of all tools in lemon/bits.
• Improvements in groups.dox.
• Fix some doxygen warnings.

File:

• lemon/bits/base_extender.h (modified) (2 diffs)

lemon/bits/base_extender.h

@@ -29 +29 @@
 #include <lemon/concepts/maps.h>
 
-///\ingroup digraphbits
-///\file
-///\brief Extenders for the digraph types
+//\ingroup digraphbits
+//\file
+//\brief Extenders for the digraph types
 namespace lemon {
 
-  /// \ingroup digraphbits
-  ///
-  /// \brief BaseDigraph to BaseGraph extender
+  // \ingroup digraphbits
+  //
+  // \brief BaseDigraph to BaseGraph extender
   template <typename Base>
   class UndirDigraphExtender : public Base {
@@ -75 +75 @@
     };
 
-    /// First node of the edge
+    // First node of the edge
     Node u(const Edge &e) const {
       return Parent::source(e);
     }
 
-    /// Source of the given arc
+    // Source of the given arc
     Node source(const Arc &e) const {
       return e.forward ? Parent::source(e) : Parent::target(e);
     }
 
-    /// Second node of the edge
+    // Second node of the edge
     Node v(const Edge &e) const {
       return Parent::target(e);
     }
 
-    /// Target of the given arc
+    // Target of the given arc
     Node target(const Arc &e) const {
       return e.forward ? Parent::target(e) : Parent::source(e);
     }
 
-    /// \brief Directed arc from an edge.
-    ///
-    /// Returns a directed arc corresponding to the specified edge.
-    /// If the given bool is true, the first node of the given edge and
-    /// the source node of the returned arc are the same.
+    // \brief Directed arc from an edge.
+    //
+    // Returns a directed arc corresponding to the specified edge.
+    // If the given bool is true, the first node of the given edge and
+    // the source node of the returned arc are the same.
     static Arc direct(const Edge &e, bool d) {
       return Arc(e, d);
     }
 
-    /// Returns whether the given directed arc has the same orientation
-    /// as the corresponding edge.
+    // Returns whether the given directed arc has the same orientation
+    // as the corresponding edge.
     static bool direction(const Arc &a) { return a.forward; }