diff --git a/doc/Doxyfile.extra.in b/doc/Doxyfile.extra.in new file mode 100644 index 0000000000000000000000000000000000000000..707e217c78663d2961058b00721d3e5fadf35c7a --- /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 0000000000000000000000000000000000000000..a7856bfee6293552c4e17fe7d35706bf7e716a6f --- /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