diff --git a/etc/doxygen/mainpage.dox b/etc/doxygen/mainpage.dox new file mode 100644 index 0000000000000000000000000000000000000000..8f58717467c8d014a29fba74dadcd9a5499a81c1 --- /dev/null +++ b/etc/doxygen/mainpage.dox @@ -0,0 +1,14 @@ +/** +\mainpage + + \li \subpage RobotAPI-Overview "RobotAPI Overview" + \li \subpage RobotAPI-Installation "RobotAPI Installation" + \li \subpage RobotAPI-Tutorials "RobotAPI Tutorials" + \li \subpage RobotAPI-HowTos "RobotAPI Howtos" + \li \subpage RobotAPI-FAQ "RobotAPI FAQ" + \li \subpage RobotAPI-Components "RobotAPI Components" + \li \subpage RobotAPI-GuiPlugins "RobotAPI Gui Plugins" + \li \subpage RobotAPI-About "RobotAPI About" + \li \subpage RobotAPI-License "RobotAPI License" + +*/ diff --git a/etc/doxygen/pages/0.Overview.dox b/etc/doxygen/pages/0.Overview.dox index 6504037bb9ddb82390d79c1c258332072445f80d..2053028a162a753d7a73a81c229d9a95339ebcac 100644 --- a/etc/doxygen/pages/0.Overview.dox +++ b/etc/doxygen/pages/0.Overview.dox @@ -1,5 +1,5 @@ /** -\defgroup RobotAPI RobotAPI Overview +\page RobotAPI-Overview RobotAPI Overview \brief The RobotAPI package provides a robot-intependent API that other ArmarX packages can use for accessing central functionality of a robot. diff --git a/etc/doxygen/pages/2.Tutorials.dox b/etc/doxygen/pages/2.Tutorials.dox index 6bcd7cdbe75647bed1e9906ed070ba19ba7af2da..06d62b24b3971affc90d2fa318dfb43c2ccc9e99 100644 --- a/etc/doxygen/pages/2.Tutorials.dox +++ b/etc/doxygen/pages/2.Tutorials.dox @@ -2,10 +2,7 @@ \cond DOXYGEN_EXCLUDE TODO: Uncomment once tutorials are available - \addtogroup Tutorials 2. Tutorials - - \defgroup RobotAPI-Tutorials RobotAPI Tutorials - \ingroup RobotAPI Tutorials + \page RobotAPI-Tutorials RobotAPI Tutorials Tutorials related to RobotAPI \endcond diff --git a/etc/doxygen/pages/3.HowTos.dox b/etc/doxygen/pages/3.HowTos.dox index 6660541d5da2d52eae88b69319d2cd18bca14d60..9d4b59dfd9a8575fcf9cef5a3294605d554bcbb9 100644 --- a/etc/doxygen/pages/3.HowTos.dox +++ b/etc/doxygen/pages/3.HowTos.dox @@ -1,15 +1,11 @@ /** -\addtogroup HowTos 3. HowTos - -\defgroup RobotAPI-HowTos RobotAPI HowTos -\ingroup RobotAPI HowTos +\page RobotAPI-HowTos RobotAPI HowTos \brief -\page RobotAPI-HowTos-Eigen-From-Pose How to convert a pose variants to an Eigen matrices -\ingroup RobotAPI-HowTos +\section RobotAPI-HowTos-Eigen-From-Pose How to convert a pose variants to an Eigen matrices Use the following code if you want to convert from an armarx::Pose, an armarx::FramedPose or an armarx::LinkedPose. Refer to \ref RobotAPI-FramedPose for further information. @@ -29,8 +25,7 @@ Refer to \ref RobotAPI-FramedPose for further information. -\page RobotAPI-HowTos-Eigen-From-PosOrient How to convert position and orientation variants to an Eigen matrices -\ingroup RobotAPI-HowTos +\section RobotAPI-HowTos-Eigen-From-PosOrient How to convert position and orientation variants to an Eigen matrices Use the following code if you want to convert from armarx::FramedPosition and armarx::FramedOrientation. Refer to \ref RobotAPI-FramedPose for further information. @@ -52,15 +47,14 @@ Refer to \ref RobotAPI-FramedPose for further information. -\page RobotAPI-HowTos-Change-Pose-Frame How to change a frame of a coordinate/pose -\ingroup RobotAPI-HowTos +\section RobotAPI-HowTos-Change-Pose-Frame How to change a frame of a coordinate/pose + Refer to \ref RobotAPI-FramedPose. -\page RobotAPI-HowTos-RemoteRobot-Start How to start a RobotStateComponent -\ingroup RobotAPI-HowTos +\section RobotAPI-HowTos-RemoteRobot-Start How to start a RobotStateComponent The RobotState component serves as a central component for storing all robot related data. For now this data covers the current joint angles of the robot.<br> The RobotStateComponent implements a KinematicUnitListener, hence it reacts on all joint updates that are reported by a KinematicUnit component. An exemplary startup script could look like this @@ -91,8 +85,7 @@ With the corresponding configuration in ./config/Armar3Config.cfg: -\page RobotAPI-HowTos-RemoteRobot-Access How to access a RobotStateComponent -\ingroup RobotAPI-HowTos +\section RobotAPI-HowTos-RemoteRobot-Access How to access a RobotStateComponent The RobotStateComponent provides several methods for accessing the current configuration of the robot and for getting a snapshot of the current state which is compatible with models of the Simox/VirtualRobot framework. With these models the whole functionality of Simox (http://simox.sf.net) can be used, e.g. IK solving, collision detection or motion and grasp planning. diff --git a/etc/doxygen/pages/4.FAQ.dox b/etc/doxygen/pages/4.FAQ.dox index d7d25537ddbae5d1c22753e11815513c0217fbc3..0954a599378ad88a002b8816fd00156903a800e4 100644 --- a/etc/doxygen/pages/4.FAQ.dox +++ b/etc/doxygen/pages/4.FAQ.dox @@ -2,9 +2,6 @@ \cond DOXYGEN_EXCLUDE TODO: Uncomment once FAQ is available - \addtogroup FAQ 4. FAQ - - \defgroup RobotAPI-FAQ RobotAPI FAQ - \ingroup RobotAPI FAQ + \page RobotAPI-FAQ RobotAPI FAQ \endcond */ diff --git a/etc/doxygen/pages/mainpage.dox b/etc/doxygen/pages/mainpage.dox deleted file mode 100644 index ec316950eb1d7ce953f3fd4b439ef16cb1b252e0..0000000000000000000000000000000000000000 --- a/etc/doxygen/pages/mainpage.dox +++ /dev/null @@ -1,4 +0,0 @@ -/** -\mainpage -\ref RobotAPI "RobotAPI Overview" -*/