Skip to content
Snippets Groups Projects
Commit de536b1a authored by Joseph Mirabel's avatar Joseph Mirabel Committed by Joseph Mirabel
Browse files

Update documentation.

parent 4e740312
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment