Changeset 1573:b76a0af36f44 in lemon-0.x

Timestamp:

07/20/05 10:06:32 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2072

Message:

• graph_to_eps_demo.cc is rightly documented
• Fix/improve documentation of graphToEps()
• Missing const added to ColorSet::size();

Files:

• demo/graph_to_eps_demo.cc (modified) (7 diffs)
• lemon/graph_to_eps.h (modified) (9 diffs)

demo/graph_to_eps_demo.cc

@@ -15 +15 @@
  */
 
-#include<lemon/graph_to_eps.h>
-#include<lemon/maps.h>
-#include<lemon/list_graph.h>
-#include<lemon/graph_utils.h>
+/// \ingroup demos
+/// \file
+/// \brief Demo of the graph grawing function \ref graphToEps()
+///
+/// This demo program shows examples how to  use the function \ref
+/// graphToEps(). It takes no input but simply creates  six
+/// <tt>.eps</tt> files demonstrating how to draw directed/undirected
+/// graphs, how to handle parallel egdes, how to change the properties
+/// (like color, shape, size, title etc.) of nodes and edges
+/// individually using appropriate \ref maps-page "graphmaps".
 
 #include <cmath>
 
+#include<lemon/graph_to_eps.h>
+#include<lemon/list_graph.h>
 
 using namespace std;
@@ -67 +75 @@
   IdMap<ListGraph,Node> id(g);
 
+  cout << "Create 'graph_to_eps_demo_out.eps'" << endl;
   graphToEps(g,"graph_to_eps_demo_out.eps").scale(10).coords(coords).
     title("Sample .eps figure").
@@ -78 +87 @@
     run();
 
+
+  cout << "Create 'graph_to_eps_demo_out_arr.eps'" << endl;
   graphToEps(g,"graph_to_eps_demo_out_arr.eps").scale(10).
     title("Sample .eps figure (with arrowheads)").
@@ -102 +113 @@
   e=g.addEdge(n1,n2); ecolors[e]=7; widths[e]=1;
 
+  cout << "Create 'graph_to_eps_demo_out_par.eps'" << endl;
   graphToEps(g,"graph_to_eps_demo_out_par.eps").scale(10).
     title("Sample .eps figure (parallel edges)").
@@ -115 +127 @@
     run();
   
+  cout << "Create 'graph_to_eps_demo_out_par_arr.eps'" << endl;
   graphToEps(g,"graph_to_eps_demo_out_par_arr.eps").scale(10).
     title("Sample .eps figure (parallel edges and arrowheads)").
@@ -129 +142 @@
     run();
 
+  cout << "Create 'graph_to_eps_demo_out_a4.eps'" << endl;
   graphToEps(g,"graph_to_eps_demo_out_a4.eps").scaleToA4().
     title("Sample .eps figure (fits to A4)").
@@ -154 +168 @@
   }
   
+  cout << "Create 'graph_to_eps_demo_out_colors.eps'" << endl;
   graphToEps(h,"graph_to_eps_demo_out_colors.eps").scale(60).
-    title("Sample .eps figure (parallel edges and arrowheads)").
+    title("Sample .eps figure (ColorSet demo)").
     copyright("(C) 2005 LEMON Project").
     coords(hcoords).

lemon/graph_to_eps.h

@@ -69 +69 @@
 ///Maps <tt>int</tt>s to different \ref Color "Color"s
 
-///This map assing one of the predefined \ref Color "Color"s
+///This map assigns one of the predefined \ref Color "Color"s
 ///to each <tt>int</tt>. It is possible to change the colors as well as their
 ///number. The integer range is cyclically mapped to the provided set of colors.
@@ -146 +146 @@
   void resize(int s) { colors.resize(s);}
   ///Returns the munber of the existing colors.
-  std::size_t size() { return colors.size();}
+  std::size_t size() const { return colors.size();}
 };
 
@@ -467 +467 @@
   ///the PostScript block inserted.
   ///
-  ///Before and after the block a newline character is inserted to you
+  ///Before and after the block a newline character is inserted so you
   ///don't have to bother with the separators.
   ///
@@ -503 +503 @@
 
   ///Sets the map of the node colors
-  ///\param x must be a node map with \ref Color values. 
+  ///\param x must be a node map with \ref Color values.
+  ///
+  ///\sa ColorSet
   template<class X> GraphToEps<NodeColorsTraits<X> >
   nodeColors(const X &x)
@@ -518 +520 @@
   ///Sets the map of the node text colors
   ///\param x must be a node map with \ref Color values. 
+  ///
+  ///\sa ColorSet
   template<class X> GraphToEps<NodeTextColorsTraits<X> >
   nodeTextColors(const X &x)
@@ -534 +538 @@
   ///Sets the map of the edge colors
   ///\param x must be a edge map with \ref Color values. 
+  ///
+  ///\sa ColorSet
   template<class X> GraphToEps<EdgeColorsTraits<X> >
   edgeColors(const X &x)
@@ -622 +628 @@
   ///Sets the color of the node texts to be as different from the node color
   ///as it is possible
-    ///
+  ///
   GraphToEps<T> &distantColorNodeTexts()
   {_nodeTextColorType=DIST_COL;return *this;}
@@ -1009 +1015 @@
 ///to the end of the parameter list.
 ///\sa GraphToEps
-///\sa graphToEps(G &g, char *file_name)
+///\sa graphToEps(G &g, const char *file_name)
 template<class G>
 GraphToEps<DefaultGraphToEpsTraits<G> > 
@@ -1020 +1026 @@
 ///Generates an EPS file from a graph
 
-///\ingroup misc
+///\ingroup io_group
 ///This function does the same as
 ///\ref graphToEps(G &g,std::ostream& os)