From 370408d7c2af3dac892a96e02a39e6f98b4c1e1f Mon Sep 17 00:00:00 2001
From: Florent Lamiraux <florent@laas.fr>
Date: Sat, 9 Nov 2013 09:29:28 +0100
Subject: [PATCH] Add documentation.
---
doc/Doxyfile.extra.in | 3 +++
doc/mainpage.hh | 17 +++++++++++++++++
2 files changed, 20 insertions(+)
create mode 100644 doc/Doxyfile.extra.in
create mode 100644 doc/mainpage.hh
diff --git a/doc/Doxyfile.extra.in b/doc/Doxyfile.extra.in
new file mode 100644
index 0000000..707e217
--- /dev/null
+++ b/doc/Doxyfile.extra.in
@@ -0,0 +1,3 @@
+INPUT = @PROJECT_SOURCE_DIR@/include \
+ @PROJECT_SOURCE_DIR@/doc
+
diff --git a/doc/mainpage.hh b/doc/mainpage.hh
new file mode 100644
index 0000000..a7856bf
--- /dev/null
+++ b/doc/mainpage.hh
@@ -0,0 +1,17 @@
+/// \mainpage
+///
+/// \section Introduction
+///
+/// This package implements a bridge between ROS and the stack of tasks.
+/// The main features are
+/// \li A service <c>Run_command</c> that enables users to communicate with
+/// a remote python interpreter in order to build and control a graph,
+/// \li A class <c>dynamicgraph::RosRobotModel</c> deriving from
+/// <c>dynamicgraph::sot::Dynamic</c> that implements an entity computing
+/// forward kinematics and dynamics based on a urdf file. for
+/// more information, type in a python terminal
+/// \code
+/// from dynamic_graph.ros.robot_model import RosRobotModel
+/// model = RosRobotModel ("model")
+/// model.help ()
+/// \endcode
--
GitLab