From de536b1aea33701ab969a6b718c68b017c323da5 Mon Sep 17 00:00:00 2001
From: Joseph Mirabel <jmirabel@laas.fr>
Date: Wed, 4 Mar 2015 15:29:43 +0100
Subject: [PATCH] Update documentation.
---
include/hpp/manipulation/graph/edge.hh | 5 +++++
include/hpp/manipulation/graph/graph-component.hh | 7 +++++++
include/hpp/manipulation/graph/graph.hh | 5 +++++
include/hpp/manipulation/graph/node.hh | 5 +++++
4 files changed, 22 insertions(+)
diff --git a/include/hpp/manipulation/graph/edge.hh b/include/hpp/manipulation/graph/edge.hh
index 982f201..2e64c20 100644
--- a/include/hpp/manipulation/graph/edge.hh
+++ b/include/hpp/manipulation/graph/edge.hh
@@ -52,6 +52,9 @@ namespace hpp {
C c_;
};
+ /// \addtogroup constraint_graph
+ /// \{
+
/// Abstract class representing representing the link between two nodes.
class HPP_MANIPULATION_DLLAPI Edge : public GraphComponent
{
@@ -262,6 +265,8 @@ namespace hpp {
/// This histogram will be used to find a good level set.
LeafHistogramPtr_t hist_;
}; // class LevelSetEdge
+
+ /// \}
} // namespace graph
} // namespace manipulation
} // namespace hpp
diff --git a/include/hpp/manipulation/graph/graph-component.hh b/include/hpp/manipulation/graph/graph-component.hh
index f06ed8d..86b48bc 100644
--- a/include/hpp/manipulation/graph/graph-component.hh
+++ b/include/hpp/manipulation/graph/graph-component.hh
@@ -32,6 +32,11 @@ namespace hpp {
namespace graph {
HPP_MAKE_EXCEPTION ( HPP_MANIPULATION_DLLAPI, Bad_function_call );
+ /// \defgroup constraint_graph Constraint Graph
+
+ /// \addtogroup constraint_graph
+ /// \{
+
/// Define common methods of the graph components.
class HPP_MANIPULATION_DLLAPI GraphComponent
{
@@ -122,6 +127,8 @@ namespace hpp {
};
std::ostream& operator<< (std::ostream& os, const GraphComponent& graphComp);
+
+ /// \}
} // namespace graph
} // namespace manipulation
diff --git a/include/hpp/manipulation/graph/graph.hh b/include/hpp/manipulation/graph/graph.hh
index bcbb3b5..22920f8 100644
--- a/include/hpp/manipulation/graph/graph.hh
+++ b/include/hpp/manipulation/graph/graph.hh
@@ -25,6 +25,9 @@
namespace hpp {
namespace manipulation {
namespace graph {
+ /// \addtogroup constraint_graph
+ /// \{
+
/// Description of the constraint graph.
///
/// This class contains a graph representing a robot with several
@@ -125,6 +128,8 @@ namespace hpp {
value_type errorThreshold_;
size_type maxIterations_;
}; // Class Graph
+
+ /// \}
} // namespace graph
} // namespace manipulation
diff --git a/include/hpp/manipulation/graph/node.hh b/include/hpp/manipulation/graph/node.hh
index ecefcfb..e7644c3 100644
--- a/include/hpp/manipulation/graph/node.hh
+++ b/include/hpp/manipulation/graph/node.hh
@@ -33,6 +33,9 @@
namespace hpp {
namespace manipulation {
namespace graph {
+ /// \addtogroup constraint_graph
+ /// \{
+
/// State of an end-effector.
///
/// Nodes of the graph of constraints. There is one
@@ -153,6 +156,8 @@ namespace hpp {
/// Weak pointer to itself.
NodeWkPtr_t wkPtr_;
}; // class Node
+
+ /// \}
} // namespace graph
} // namespace manipulation
} // namespace hpp
--
GitLab