Changeset 133:d76e2ff9c70d in lemon-1.2 for lemon/color.h

Timestamp:

04/13/08 09:20:43 (16 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Several doc improvements + new default parameter values

• * *

Several minor improvements in graph_to_eps.h

• * *

Several minor improvements in graph_to_eps.h

File:

• lemon/color.h (modified) (3 diffs)

lemon/color.h

@@ -112 +112 @@
 
     ///Constructor 
+    ///\param have_white indicates whether white is amongst the
+    ///provided initial colors (\c true) or not (\c false). If it is true,
+    ///white will be assigned to \c 0.
     ///\param num the number of the allocated colors. If it is \c -1,
-    ///the default color configuration is set up (26 color plus the
+    ///the default color configuration is set up (26 color plus optionaly the
     ///white).  If \c num is less then 26/27 then the default color
     ///list is cut. Otherwise the color list is filled repeatedly with
     ///the default color list.  (The colors can be changed later on.)
-    ///\param have_white indicates whether white is amongst the
-    ///provided color (\c true) or not (\c false). If it is true,
-    ///white will be assigned to \c 0.
     Palette(bool have_white=false,int num=-1)
     {
@@ -174 +174 @@
       colors[i%colors.size()]=c;
     }
-    ///\e
+    ///Add a new color to the end of the color list.
     void add(const Color &c) 
     {
@@ -186 +186 @@
   };
 
-  ///Returns a visible distinct \ref Color
+  ///Returns a visibly distinct \ref Color
 
   ///Returns a \ref Color which is as different from the given parameter