* mln/core/image/complex_image.hh,
* mln/core/var.hh,
* mln/util/line_graph.hh:
Here.
---
milena/ChangeLog | 9 +++++++++
milena/mln/core/image/complex_image.hh | 2 +-
milena/mln/core/var.hh | 8 ++++----
milena/mln/util/line_graph.hh | 5 ++---
4 files changed, 16 insertions(+), 8 deletions(-)
diff --git a/milena/ChangeLog b/milena/ChangeLog
index 0f3a8a2..b6992d2 100644
--- a/milena/ChangeLog
+++ b/milena/ChangeLog
@@ -1,5 +1,14 @@
2009-06-09 Roland Levillain <roland(a)lrde.epita.fr>
+ Aestetic changes and cleanup in documentation and comments.
+
+ * mln/core/image/complex_image.hh,
+ * mln/core/var.hh,
+ * mln/util/line_graph.hh:
+ Here.
+
+2009-06-09 Roland Levillain <roland(a)lrde.epita.fr>
+
Stop using \arg instead of \param or \tparam in documentation.
* mln/core/faces_psite.hh,
diff --git a/milena/mln/core/image/complex_image.hh
b/milena/mln/core/image/complex_image.hh
index b1788c3..9f273a5 100644
--- a/milena/mln/core/image/complex_image.hh
+++ b/milena/mln/core/image/complex_image.hh
@@ -112,7 +112,7 @@ namespace mln
} // end of namespace mln::trait
- /// Image based on a complex.
+ /// \brief Image based on a complex.
///
/// Values attached to each face of the complex.
///
diff --git a/milena/mln/core/var.hh b/milena/mln/core/var.hh
index 8288e06..9892815 100644
--- a/milena/mln/core/var.hh
+++ b/milena/mln/core/var.hh
@@ -27,11 +27,11 @@
# define MLN_CORE_VAR_HH
/// \file
+/// \brief Various macros (syntactic sugar) to shorten declarations of
+/// variables.
///
-/// This file contains various macros to declare variables.
-///
-/// Warning: that macro relies on an extention of g++ (typeof) so it is
-/// NOT standard C++.
+/// \warning Theses macro rely on an extension of g++ (\c typeof) so it
+/// is NOT standard C++.
# include <mln/core/macros.hh>
diff --git a/milena/mln/util/line_graph.hh b/milena/mln/util/line_graph.hh
index f367b77..af11d02 100644
--- a/milena/mln/util/line_graph.hh
+++ b/milena/mln/util/line_graph.hh
@@ -77,7 +77,6 @@ namespace mln
/// \brief Undirected line graph of a graph of type \p G.
///
/// \ingroup modgraph
- //
template <typename G>
class line_graph : public internal::graph_base< line_graph<G> >
{
@@ -253,7 +252,7 @@ namespace mln
g_ = g;
// Initialize vertices and edges.
- //FIXME: use an adjacency matrix!!
+ // FIXME: use an adjacency matrix!!
std::set<util::ord_pair<util::vertex_id_t> > edges_set;
vertices_.resize(g.e_nmax());
@@ -339,7 +338,7 @@ namespace mln
bool
line_graph<G>::has(const util::vertex<G2>& v) const
{
- //FIXME: not sure...
+ // FIXME: not sure...
return v.graph().is_subgraph_of(*this) && has_v(v.id());
}
--
1.6.1.2
Show replies by date