[Lemon-commits] [lemon_svn] alpar: r1425 - hugo/trunk/src/lemon

[Lemon SVN]

Author: alpar
Date: Thu Dec  9 18:02:53 2004
New Revision: 1425

Modified:
   hugo/trunk/src/lemon/list_graph.h
   hugo/trunk/src/lemon/smart_graph.h

Log:
Make UndirListGraph and UndirSmartGraph visible in the doc.

Modified: hugo/trunk/src/lemon/list_graph.h
==============================================================================
--- hugo/trunk/src/lemon/list_graph.h	(original)
+++ hugo/trunk/src/lemon/list_graph.h	Thu Dec  9 18:02:53 2004
@@ -398,6 +398,7 @@
     ///\warning Edge and node deletions cannot be restored.
     ///\warning SnapShots cannot be nested.
     ///\ingroup graphs
+    ///\todo \c SnapShot or \c Snapshot?
     class SnapShot : protected AlterationObserverRegistry<Node>::ObserverBase,
 		     protected AlterationObserverRegistry<Edge>::ObserverBase
     {
@@ -512,6 +513,17 @@
     AlterableUndirGraphExtender<
     UndirGraphExtender<ListGraphBase> > > > > > > ErasableUndirListGraphBase;
 
+  ///An undirected list graph class.
+
+  ///This is a simple and fast erasable undirected graph implementation.
+  ///
+  ///It conforms to the
+  ///\ref concept::UndirGraph "UndirGraph" concept.
+  ///
+  ///\sa concept::UndirGraph.
+  ///
+  ///\todo SnapShot hasn't been implemented yet.
+  ///
   class UndirListGraph : public ErasableUndirListGraphBase {
   };
 

Modified: hugo/trunk/src/lemon/smart_graph.h
==============================================================================
--- hugo/trunk/src/lemon/smart_graph.h	(original)
+++ hugo/trunk/src/lemon/smart_graph.h	Thu Dec  9 18:02:53 2004
@@ -236,8 +236,6 @@
   ///the \ref concept::ExtendableGraph "ExtendableGraph" concept.
   ///\sa concept::ExtendableGraph.
   ///
-  ///\todo Some member functions could be \c static.
-  ///
   ///\author Alpar Juttner
   class SmartGraph : public ClearableSmartGraphBase {
   public:
@@ -358,6 +356,18 @@
     AlterableUndirGraphExtender<
     UndirGraphExtender<SmartGraphBase> > > > > > UndirSmartGraphBase;
 
+  ///A smart undirected graph class.
+
+  ///This is a simple and fast undirected graph implementation.
+  ///It is also quite memory efficient, but at the price
+  ///that <b> it does support only limited (only stack-like)
+  ///node and edge deletions</b>.
+  ///Except from this it conforms to 
+  ///the \ref concept::UndirGraph "UndirGraph" concept.
+  ///\sa concept::UndirGraph.
+  ///
+  ///\todo SnapShot hasn't been implemented yet.
+  ///
   class UndirSmartGraph : public UndirSmartGraphBase {
   };