LEMON/LEMON-official Changeset - r133:d76e2ff9c70d

Repositories » LEMON » LEMON-official

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r133:d76e2ff9c70d

« 132:50ff94

134:0775d2 »

r133:d76e2ff9c70d

Sun, 13 Apr 2008 09:20:43

[Not Reviewed]

0 comments (0 inline)

alpar (Alpar Juttner)
alpar@cs.elte.hu

Several doc improvements + new default parameter values * * * Several minor improvements in graph_to_eps.h * * * Several minor improvements in graph_to_eps.h

0 2 0

default

2 files changed with 27 insertions and 34 deletions:

lemon/color.h

lemon/graph_to_eps.h

↑ Collapse diff ↑

lemon/color.h

Show inline comments

@@ -112,12 +112,12 @@
 		    ///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,5 +174,5 @@
 		      colors[i%colors.size()]=c;
+		    }
-		    ///\e
+		    ///Add a new color to the end of the color list.
 		    void add(const Color &c)
+		    {
@@ -186,5 +186,5 @@
 		  };
-		  ///Returns a visible distinct \ref Color
+		  ///Returns a visibly distinct \ref Color
 		  ///Returns a \ref Color which is as different from the given parameter

lemon/graph_to_eps.h

Show inline comments

@@ -44,7 +44,5 @@
 		///\ingroup eps_io
 		///\file
 		///\brief Simple graph drawer
 		///
-		///\author Alpar Juttner
+		///\brief A well configurable tool for visualizing graphs
 		namespace lemon {
@@ -173,14 +171,7 @@
 		};
-		///Helper class to implement the named parameters of \ref graphToEps()
+		///Auxiliary class to implement the named parameters of \ref graphToEps()
 		///Helper class to implement the named parameters of \ref graphToEps()
 		///\todo Is 'helper class' a good name for this?
 		///
 		///\todo Follow PostScript's DSC.
 		/// Use own dictionary.
 		///\todo Useful new features.
 		/// - Linestyles: dotted, dashed etc.
 		/// - A second color and percent value for the lines.
 		///Auxiliary class to implement the named parameters of \ref graphToEps()
 		template<class T> class GraphToEps : public T
+		{
@@ -370,5 +361,5 @@
 		  ///Sets the map of the node shapes.
-		  ///The availabe shape values
+		  ///The available shape values
 		  ///can be found in \ref NodeShapes "enum NodeShapes".
 		  ///\param x must be a node map with \c int (or convertible) values.
@@ -412,6 +403,4 @@
 		  ///
 		  ///\sa nodePsTextsPreamble()
 		  ///\todo Offer the choise not to move to the centre but pass the coordinates
 		  ///to the Postscript block inserted.
 		  template<class X> GraphToEps<NodePsTextsTraits<X> > nodePsTexts(const X &x)
+		  {
@@ -522,11 +511,9 @@
 		  ///Negates the Y coordinates.
 		  ///
 		  ///\todo More docs.
 		  ///
 		  GraphToEps<T> &negateY(bool b=true) {
 		    _negY=b;return *this;
+		  }
-		  ///Turn on/off prescaling
+		  ///Turn on/off pre-scaling
 		  ///By default graphToEps() rescales the whole image in order to avoid
@@ -579,5 +566,5 @@
 		  ///Sets the width of the border around the picture
 		  ///
 		  GraphToEps<T> &border(double b) {_xBorder=_yBorder=b;return *this;}
+		  GraphToEps<T> &border(double b=10) {_xBorder=_yBorder=b;return *this;}
 		  ///Sets the width of the border around the picture
@@ -596,10 +583,10 @@
 		  ///Sets the length of the arrowheads
 		  ///
 		  GraphToEps<T> &arrowLength(double d) {_arrowLength*=d;return *this;}
+		  GraphToEps<T> &arrowLength(double d=1.0) {_arrowLength*=d;return *this;}
 		  ///Sets the width of the arrowheads
 		  ///Sets the width of the arrowheads
 		  ///
 		  GraphToEps<T> &arrowWidth(double d) {_arrowWidth*=d;return *this;}
+		  GraphToEps<T> &arrowWidth(double d=.3) {_arrowWidth*=d;return *this;}
 		  ///Scales the drawing to fit to A4 page
@@ -663,7 +650,10 @@
 		  ///Sets whether the the graph is undirected
 		  ///Sets whether the the graph is undirected
+		  ///Sets whether the the graph is undirected.
 		  ///
-		  GraphToEps<T> &undirected(bool b=true) {_undirected=b;return *this;}
+		  ///This setting is the default for undirected graphs.
 		  ///
 		  ///\sa directed()
 		   GraphToEps<T> &undirected(bool b=true) {_undirected=b;return *this;}
 		  ///Sets whether the the graph is directed
@@ -671,6 +661,10 @@
 		  ///Sets whether the the graph is directed.
 		  ///Use it to show the edges as a pair of directed ones.
 		  ///
 		  ///This setting is the default for digraphs.
 		  ///
 		  ///\sa undirected()
 		  GraphToEps<T> &directed(bool b=true) {_undirected=!b;return *this;}
 		  ///Sets the title.
@@ -684,5 +678,4 @@
 		  ///namely it inserts a <tt>%%Copyright:</tt> DSC field to the header of
 		  ///the EPS file.
 		  ///\todo Multiline copyright notice could be supported.
 		  GraphToEps<T> &copyright(const std::string &t) {_copyright=t;return *this;}
@@ -710,8 +703,8 @@
 		  ///Like other functions using
 		  ///\ref named-templ-func-param "named template parameters",
-		  ///this function calles the algorithm itself, i.e. in this case
+		  ///this function calls the algorithm itself, i.e. in this case
 		  ///it draws the graph.
 		  void run() {
-		    ///\todo better 'epsilon' would be nice here.
 		    //\todo better 'epsilon' would be nice here.
 		    const double EPSILON=1e-9;
 		    if(dontPrint) return;
@@ -931,5 +924,5 @@
 			    dvec(mycoords[g.target(*i)]-mycoords[g.source(*i)]);
 			  double l=std::sqrt(dvec.normSquare());
-			  ///\todo better 'epsilon' would be nice here.
 			  //\todo better 'epsilon' would be nice here.
 			  dim2::Point<double> d(dvec/std::max(l,EPSILON));
 		 	  dim2::Point<double> m;

0 comments (0 inline)

RhodeCode

Login to your account