[Lemon-commits] Peter Kovacs: Fix several doxygen warnings
Lemon HG
hg at lemon.cs.elte.hu
Thu Oct 9 14:58:08 CEST 2008
details: http://lemon.cs.elte.hu/hg/lemon/rev/64f8f7cc6168
changeset: 313:64f8f7cc6168
user: Peter Kovacs <kpeter [at] inf.elte.hu>
date: Thu Oct 09 10:09:44 2008 +0200
description:
Fix several doxygen warnings
diffstat:
16 files changed, 56 insertions(+), 63 deletions(-)
demo/graph_to_eps_demo.cc | 2 -
doc/lgf.dox | 2 -
lemon/bits/alteration_notifier.h | 3 --
lemon/bits/default_map.h | 2 -
lemon/color.h | 2 -
lemon/concepts/graph_components.h | 2 -
lemon/core.h | 10 +++----
lemon/dfs.h | 2 -
lemon/dijkstra.h | 4 +--
lemon/dim2.h | 47 ++++++++++++++++---------------------
lemon/graph_to_eps.h | 2 -
lemon/list_graph.h | 2 -
lemon/maps.h | 10 +++----
lemon/path.h | 2 -
lemon/smart_graph.h | 8 +++---
lemon/time_measure.h | 19 +++++++-------
diffs (truncated from 461 to 300 lines):
diff -r e57e10a8ea1b -r 64f8f7cc6168 demo/graph_to_eps_demo.cc
--- a/demo/graph_to_eps_demo.cc Wed Oct 08 17:05:01 2008 +0100
+++ b/demo/graph_to_eps_demo.cc Thu Oct 09 10:09:44 2008 +0200
@@ -26,7 +26,7 @@
/// graphToEps(), and showing how to draw directed graphs,
/// how to handle parallel egdes, how to change the properties (like
/// color, shape, size, title etc.) of nodes and arcs individually
-/// using appropriate \ref maps-page "graph maps".
+/// using appropriate graph maps.
///
/// \include graph_to_eps_demo.cc
diff -r e57e10a8ea1b -r 64f8f7cc6168 doc/lgf.dox
--- a/doc/lgf.dox Wed Oct 08 17:05:01 2008 +0100
+++ b/doc/lgf.dox Thu Oct 09 10:09:44 2008 +0200
@@ -78,7 +78,7 @@
2 3 18
\endcode
-The \c \@edges is just a synonym of \c \@arcs. The @arcs section can
+The \c \@edges is just a synonym of \c \@arcs. The \@arcs section can
also store the edge set of an undirected graph. In such case there is
a conventional method for store arc maps in the file, if two columns
has the same caption with \c '+' and \c '-' prefix, then these columns
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/bits/alteration_notifier.h
--- a/lemon/bits/alteration_notifier.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/bits/alteration_notifier.h Thu Oct 09 10:09:44 2008 +0200
@@ -79,8 +79,7 @@
/// observeres will not be notified and the fulfilled additions will
/// be rolled back by calling the \e erase() or \e clear()
/// functions. Thence the \e erase() and \e clear() should not throw
- /// exception. Actullay, it can be throw only
- /// \ref AlterationObserver::ImmediateDetach ImmediateDetach
+ /// exception. Actullay, it can be throw only \ref ImmediateDetach
/// exception which detach the observer from the notifier.
///
/// There are some place when the alteration observing is not completly
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/bits/default_map.h
--- a/lemon/bits/default_map.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/bits/default_map.h Thu Oct 09 10:09:44 2008 +0200
@@ -149,7 +149,7 @@
// #endif
- /// \e
+ /// DefaultMap class
template <typename _Graph, typename _Item, typename _Value>
class DefaultMap
: public DefaultMapSelector<_Graph, _Item, _Value>::Map {
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/color.h
--- a/lemon/color.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/color.h Thu Oct 09 10:09:44 2008 +0200
@@ -92,7 +92,7 @@
/// Dark cyan color constant
extern const Color DARK_CYAN;
- ///Map <tt>int</tt>s to different \ref Color "Color"s
+ ///Map <tt>int</tt>s to different <tt>Color</tt>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
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/concepts/graph_components.h
--- a/lemon/concepts/graph_components.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/concepts/graph_components.h Thu Oct 09 10:09:44 2008 +0200
@@ -982,7 +982,7 @@
/// \brief Class describing the concept of graph maps
///
/// This class describes the common interface of the graph maps
- /// (NodeMap, ArcMap), that is \ref maps-page "maps" which can be used to
+ /// (NodeMap, ArcMap), that is maps that can be used to
/// associate data to graph descriptors (nodes or arcs).
template <typename _Graph, typename _Item, typename _Value>
class GraphMap : public ReadWriteMap<_Item, _Value> {
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/core.h
--- a/lemon/core.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/core.h Thu Oct 09 10:09:44 2008 +0200
@@ -1554,7 +1554,7 @@
///\note This is a dynamic data structure, therefore the data
///structure is updated after each graph alteration. Thus although
///this data structure is theoretically faster than \ref ArcLookUp
- ///and \ref AllArcLookup, it often provides worse performance than
+ ///and \ref AllArcLookUp, it often provides worse performance than
///them.
Arc operator()(Node s, Node t, Arc p = INVALID) const {
if (p == INVALID) {
@@ -1699,8 +1699,8 @@
///Find an arc between two nodes.
- ///Find an arc between two nodes in time <em>O</em>(log<em>d</em>), where
- ///<em>d</em> is the number of outgoing arcs of \c s.
+ ///Find an arc between two nodes in time <em>O</em>(log<em>d</em>),
+ ///where <em>d</em> is the number of outgoing arcs of \c s.
///\param s The source node.
///\param t The target node.
///\return An arc from \c s to \c t if there exists,
@@ -1817,8 +1817,8 @@
///for(Arc a = ae(u,v); a != INVALID; a=ae(u,v,a)) n++;
///\endcode
///
- ///Finding the first arc take <em>O</em>(log<em>d</em>) time, where
- ///<em>d</em> is the number of outgoing arcs of \c s. Then, the
+ ///Finding the first arc take <em>O</em>(log<em>d</em>) time,
+ ///where <em>d</em> is the number of outgoing arcs of \c s. Then the
///consecutive arcs are found in constant time.
///
///\warning If you change the digraph, refresh() must be called before using
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/dfs.h
--- a/lemon/dfs.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/dfs.h Thu Oct 09 10:09:44 2008 +0200
@@ -835,7 +835,7 @@
typedef lemon::Path<Digraph> Path;
};
- /// Default traits class used by \ref DfsWizard
+ /// Default traits class used by DfsWizard
/// To make it easier to use Dfs algorithm
/// we have created a wizard class.
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/dijkstra.h
--- a/lemon/dijkstra.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/dijkstra.h Thu Oct 09 10:09:44 2008 +0200
@@ -453,7 +453,7 @@
};
/// \brief \ref named-templ-param "Named parameter" for setting
- ///\ref OperationTraits type
+ ///\c OperationTraits type
///
///\ref named-templ-param "Named parameter" for setting
///\ref OperationTraits type.
@@ -1038,7 +1038,7 @@
typedef lemon::Path<Digraph> Path;
};
- /// Default traits class used by \ref DijkstraWizard
+ /// Default traits class used by DijkstraWizard
/// To make it easier to use Dijkstra algorithm
/// we have created a wizard class.
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/dim2.h
--- a/lemon/dim2.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/dim2.h Thu Oct 09 10:09:44 2008 +0200
@@ -259,10 +259,10 @@
- /// Bounding box of plain vectors (\ref Point points).
+ /// Bounding box of plain vectors (points).
/// A class to calculate or store the bounding box of plain vectors
- /// (\ref Point points).
+ /// (\ref Point "points").
template<typename T>
class Box {
Point<T> _bottom_left, _top_right;
@@ -573,11 +573,10 @@
return os;
}
- ///Map of x-coordinates of a \ref Point "Point"-map
+ ///Map of x-coordinates of a <tt>Point</tt>-map
+ ///Map of x-coordinates of a \ref Point "Point"-map.
///\ingroup maps
- ///Map of x-coordinates of a \ref Point "Point"-map.
- ///
template<class M>
class XMap
{
@@ -592,9 +591,9 @@
void set(Key k,Value v) {_map.set(k,typename M::Value(v,_map[k].y));}
};
- ///Returns an \ref XMap class
+ ///Returns an XMap class
- ///This function just returns an \ref XMap class.
+ ///This function just returns an XMap class.
///
///\ingroup maps
///\relates XMap
@@ -610,11 +609,10 @@
return XMap<M>(m);
}
- ///Constant (read only) version of \ref XMap
+ ///Constant (read only) version of XMap
+ ///Constant (read only) version of XMap.
///\ingroup maps
- ///Constant (read only) version of \ref XMap
- ///
template<class M>
class ConstXMap
{
@@ -628,9 +626,9 @@
Value operator[](Key k) const {return _map[k].x;}
};
- ///Returns a \ref ConstXMap class
+ ///Returns a ConstXMap class
- ///This function just returns a \ref ConstXMap class.
+ ///This function just returns a ConstXMap class.
///
///\ingroup maps
///\relates ConstXMap
@@ -640,11 +638,10 @@
return ConstXMap<M>(m);
}
- ///Map of y-coordinates of a \ref Point "Point"-map
+ ///Map of y-coordinates of a <tt>Point</tt>-map
+ ///Map of y-coordinates of a \ref Point "Point"-map.
///\ingroup maps
- ///Map of y-coordinates of a \ref Point "Point"-map.
- ///
template<class M>
class YMap
{
@@ -659,9 +656,9 @@
void set(Key k,Value v) {_map.set(k,typename M::Value(_map[k].x,v));}
};
- ///Returns a \ref YMap class
+ ///Returns a YMap class
- ///This function just returns a \ref YMap class.
+ ///This function just returns a YMap class.
///
///\ingroup maps
///\relates YMap
@@ -677,11 +674,10 @@
return YMap<M>(m);
}
- ///Constant (read only) version of \ref YMap
+ ///Constant (read only) version of YMap
+ ///Constant (read only) version of YMap.
///\ingroup maps
- ///Constant (read only) version of \ref YMap
- ///
template<class M>
class ConstYMap
{
@@ -695,9 +691,9 @@
Value operator[](Key k) const {return _map[k].y;}
};
- ///Returns a \ref ConstYMap class
+ ///Returns a ConstYMap class
- ///This function just returns a \ref ConstYMap class.
+ ///This function just returns a ConstYMap class.
///
///\ingroup maps
///\relates ConstYMap
@@ -708,8 +704,7 @@
}
- ///\brief Map of the \ref Point::normSquare() "normSquare()"
- ///of a \ref Point "Point"-map
+ ///\brief Map of the normSquare() of a <tt>Point</tt>-map
///
///Map of the \ref Point::normSquare() "normSquare()"
///of a \ref Point "Point"-map.
@@ -727,9 +722,9 @@
Value operator[](Key k) const {return _map[k].normSquare();}
};
- ///Returns a \ref NormSquareMap class
+ ///Returns a NormSquareMap class
- ///This function just returns a \ref NormSquareMap class.
+ ///This function just returns a NormSquareMap class.
///
///\ingroup maps
///\relates NormSquareMap
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/graph_to_eps.h
--- a/lemon/graph_to_eps.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/graph_to_eps.h Thu Oct 09 10:09:44 2008 +0200
@@ -62,7 +62,7 @@
};
}
-///Default traits class of \ref GraphToEps
+///Default traits class of GraphToEps
///Default traits class of \ref GraphToEps.
///
diff -r e57e10a8ea1b -r 64f8f7cc6168 lemon/list_graph.h
--- a/lemon/list_graph.h Wed Oct 08 17:05:01 2008 +0100
+++ b/lemon/list_graph.h Thu Oct 09 10:09:44 2008 +0200
@@ -413,7 +413,7 @@
/// Change the source of \c a to \c n
///
More information about the Lemon-commits
mailing list