Improve doxygen doc

benoitheintz · Nov 14, 2015 · 13d4278 · 13d4278
1 parent 2971977
commit 13d4278
Show file tree

Hide file tree

Showing 36 changed files with 95 additions and 38 deletions.
diff --git a/doc/image/img-ccmake-opensuse-all.png b/doc/image/img-ccmake-opensuse-all.png
diff --git a/doc/image/img-ccmake-raspberry-pi.png b/doc/image/img-ccmake-raspberry-pi.png
diff --git a/doc/mainpage.doc.in b/doc/mainpage.doc.in
@@ -417,11 +417,61 @@ scheme, ...</p>
  \defgroup group_robot_real Real robots
  Real robots interfaces.
 */
+/*!
+ \ingroup group_robot_real
+ \defgroup group_robot_real_gantry Gantry robot
+ Afma6 gantry robot interfaces.
+*/
+/*!
+ \ingroup group_robot_real
+ \defgroup group_robot_real_cylindrical Cylindrical robot
+ Afma4 cylindrical robot interfaces.
+*/
+/*!
+ \ingroup group_robot_real
+ \defgroup group_robot_real_unicycle Unicycle robot
+ Pioneer P3DX unicycle robot interfaces.
+*/
+/*!
+ \ingroup group_robot_real
+ \defgroup group_robot_real_ptu Pan-tilt unit
+ Pan-tilt unit interfaces.
+*/
+/*!
+ \ingroup group_robot_real
+ \defgroup group_robot_real_arm Anthropomorphic arm
+ Anthropomorphic arm interfaces.
+*/
+/*!
+ \ingroup group_robot_real
+ \defgroup group_robot_real_template New robot interface (template)
+ Template for users that want to integrate their own real-robot.
+*/
 /*!
  \ingroup module_robot
  \defgroup group_robot_simu Robot simulation
  Simulated robots interfaces.
 */
+/*!
+ \ingroup group_robot_simu
+ \defgroup group_robot_simu_gantry Gantry robot simulation
+ Gantry robot interfaces.
+*/
+/*!
+ \ingroup group_robot_simu
+ \defgroup group_robot_simu_arm Anthropomorphic arm simulation
+ Anthropomorphic arm interfaces.
+*/
+/*!
+ \ingroup group_robot_simu
+ \defgroup group_robot_simu_unicycle Unicycle robot simulation
+ Pioneer P3DX unicycle robot interfaces.
+*/
+/*!
+ \ingroup group_robot_simu
+ \defgroup group_robot_simu_camera Free flying camera simulation
+ Free flying camera interfaces.
+*/
 /*!
  \ingroup module_robot
  \defgroup group_robot_image_simu Image simulation

diff --git a/doc/tutorial-install-opensuse.doc b/doc/tutorial-install-opensuse.doc
@@ -3,7 +3,7 @@
 \page tutorial-install-opensuse Tutorial: Installation from source on Linux openSUSE
 \tableofcontents
 
-In this tutorial you will learn how to install ViSP from source on openSUSE. These steps have been tested for openSUSE 13.2 (x86_64) distribution, but should work with any other distribution as well. 
+In this tutorial you will learn how to install ViSP from source on openSUSE. These steps have been tested for openSUSE 14.1 (x86_64) distribution, but should work with any other distribution as well. 
 
 \note Concerning ViSP installation, we provide also other \ref tutorial.
 
@@ -17,6 +17,10 @@ sudo zypper install gcc-c++
 \code
 sudo zypper install cmake
 \endcode
+- Git if you want to get the source code from http:https://github.com/lagadic/visp
+\code
+sudo zypper install git-core
+\endcode
 
 \section install_opensuse_3rdparty Install 3rd parties
 
@@ -86,20 +90,20 @@ We suppose now that ViSP source is in a directory denoted \<source_dir\>, for e
 
 - Create first a directory denoted \<binary_dir\> where you want to build ViSP. This directory will contain generated Makefiles, object files, and output libraries and binaries.
 \code
-cd $HOME; mkdir visp-build-release
+cd $HOME; mkdir visp-build
 \endcode
 
 - Enter the \<binary_dir\> and configure the build:
 \code
-cd $HOME/Vvisp-build-release
+cd $HOME/Vvisp-build
 cmake ../visp
 \endcode
 A more versatile way to configure the build is to use \c ccmake, the CMake GUI:
 \code
 ccmake ../visp
 \endcode
 The following image shows that this command allows to configure (just by pressing [c] key) the build in a more advanced way where some options could be easily turned On/Off. It allows also to see which are the 3rd parties that will be used. To generate the makefiles, just press [g] key in the ccmake gui.
-\image html img-ccmake-opensuse-all.png Snapshot of the ccmake \c ../visp command used to configure ViSP.
+\image html img-ccmake-ubuntu-all.png Snapshot of the ccmake \c ../visp command used to configure ViSP.
 
 \subsection install_opensuse_build Building ViSP from source
 
@@ -148,7 +152,7 @@ source ~/.bashrc
 From now, you can try to run ViSP examples and tests. For example you can run \c displayX example that should open a windows with Klimt painting image and some overlay drawings:
 
 \code
-$ cd $HOME/visp-build-release
+$ cd $HOME/visp-build
 $ ./example/device/display/displayX
 
 A click to close the windows...

diff --git a/doc/tutorial-install-raspberry.doc b/doc/tutorial-install-raspberry.doc
@@ -179,7 +179,7 @@ A more versatile way to configure the build is to use \c ccmake, the CMake GUI:
 ccmake ../visp
 \endcode
 The following image shows that this command allows to configure (just by pressing [c] key) the build in a more advanced way where some options could be easily turned On/Off. It allows also to see which are the 3rd parties that will be used. Then to generate the makefiles, just press [g] key in the ccmake gui.
-\image html img-ccmake-raspberry-pi.png Snapshot of the ccmake \c ../visp command used to configure ViSP. 
+\image html img-ccmake-ubuntu-all.png Snapshot of the ccmake \c ../visp command used to configure ViSP. 
 
 
 \subsubsection install_raspberry_visp_build Building ViSP from source

diff --git a/modules/robot/include/visp3/robot/vpAfma4.h b/modules/robot/include/visp3/robot/vpAfma4.h
@@ -50,7 +50,7 @@
 
  \class vpAfma4
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_cylindrical
 
  \brief Modelisation of Irisa's cylindrical robot named Afma4.
 

diff --git a/modules/robot/include/visp3/robot/vpAfma6.h b/modules/robot/include/visp3/robot/vpAfma6.h
@@ -50,7 +50,7 @@
 
  \class vpAfma6
 
- \ingroup group_robot_real group_robot_simu
+ \ingroup group_robot_real_gantry group_robot_simu_gantry
 
  \brief Modelisation of Irisa's gantry robot named Afma6.
 

diff --git a/modules/robot/include/visp3/robot/vpBiclops.h b/modules/robot/include/visp3/robot/vpBiclops.h
@@ -58,7 +58,7 @@
 
  \class vpBiclops
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_ptu
 
  \brief Jacobian, geometric model functionnalities... for biclops, pan, tilt
  head.

diff --git a/modules/robot/include/visp3/robot/vpPioneer.h b/modules/robot/include/visp3/robot/vpPioneer.h
@@ -46,7 +46,7 @@
 
  \class vpPioneer
 
- \ingroup group_robot_real group_robot_simu
+ \ingroup group_robot_real_unicycle group_robot_simu_unicycle
 
  \brief Generic functions for Pioneer mobile robots.
 

diff --git a/modules/robot/include/visp3/robot/vpPioneerPan.h b/modules/robot/include/visp3/robot/vpPioneerPan.h
@@ -47,7 +47,7 @@
 
  \class vpPioneerPan
 
- \ingroup group_robot_real group_robot_simu
+ \ingroup group_robot_real_unicycle group_robot_simu_unicycle
 
  \brief Generic functions for Pioneer mobile robots equiped with a pan head.
 

diff --git a/modules/robot/include/visp3/robot/vpPtu46.h b/modules/robot/include/visp3/robot/vpPtu46.h
@@ -63,7 +63,7 @@
 
  \class vpPtu46
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_ptu
 
  \brief Jacobian, geometric model functionnalities... for ptu46, pan, tilt
  head from Directed Perception.

diff --git a/modules/robot/include/visp3/robot/vpRingLight.h b/modules/robot/include/visp3/robot/vpRingLight.h
@@ -57,7 +57,7 @@
 /*!
 
  \class vpRingLight
- \ingroup group_robot_real
+ \ingroup group_robot_real_gantry
  \brief Ring light management under unix.
 
  \warning This class works only at Irisa with the Edixia's ring light system.

diff --git a/modules/robot/include/visp3/robot/vpRobot.h b/modules/robot/include/visp3/robot/vpRobot.h
@@ -51,7 +51,8 @@
 
 /*!
  \class vpRobot
- \ingroup group_robot_real
+ \ingroup group_robot_real_gantry group_robot_real_cylindrical group_robot_real_arm
+ \ingroup group_robot_real_ptu group_robot_real_unicycle group_robot_real_template
  \brief class that defines a generic virtual robot
 */
 class VISP_EXPORT vpRobot

diff --git a/modules/robot/include/visp3/robot/vpRobotAfma4.h b/modules/robot/include/visp3/robot/vpRobotAfma4.h
@@ -60,7 +60,7 @@ extern "C" {
 /*!
  \class vpRobotAfma4
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_cylindrical
 
  \brief Control of Irisa's cylindrical robot named Afma4.
 

diff --git a/modules/robot/include/visp3/robot/vpRobotAfma6.h b/modules/robot/include/visp3/robot/vpRobotAfma6.h
@@ -61,7 +61,7 @@ extern "C" {
 /*!
  \class vpRobotAfma6
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_gantry
 
  \brief Control of Irisa's gantry robot named Afma6.
 

diff --git a/modules/robot/include/visp3/robot/vpRobotBiclops.h b/modules/robot/include/visp3/robot/vpRobotBiclops.h
@@ -70,7 +70,7 @@
 /*!
  \class vpRobotBiclops
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_ptu
 
  \brief Interface for the biclops, pan, tilt head control.
 

diff --git a/modules/robot/include/visp3/robot/vpRobotBiclopsController.h b/modules/robot/include/visp3/robot/vpRobotBiclopsController.h
@@ -70,7 +70,7 @@ class VISP_EXPORT Biclops; //needed for dll creation
 
  \class vpRobotBiclopsController
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_ptu
 
  \brief Interface to Biclops, pan, tilt, verge head for computer vision
  applications.

diff --git a/modules/robot/include/visp3/robot/vpRobotCamera.h b/modules/robot/include/visp3/robot/vpRobotCamera.h
@@ -51,6 +51,7 @@
 
 /*!
  \class vpRobotCamera
+ \ingroup group_robot_simu_camera
 
  \brief Class that defines the simplest robot: a free flying camera.
 

diff --git a/modules/robot/include/visp3/robot/vpRobotPioneer.h b/modules/robot/include/visp3/robot/vpRobotPioneer.h
@@ -56,7 +56,7 @@
 
  \class vpRobotPioneer
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_unicycle
 
  \brief Interface for Pioneer mobile robots based on Aria 3rd party library.
 

diff --git a/modules/robot/include/visp3/robot/vpRobotPtu46.h b/modules/robot/include/visp3/robot/vpRobotPtu46.h
@@ -71,7 +71,7 @@
 
  \class vpRobotPtu46
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_ptu
 
  \brief Interface for the Directed Perception ptu-46 pan, tilt head .
 

diff --git a/modules/robot/include/visp3/robot/vpRobotSimulator.h b/modules/robot/include/visp3/robot/vpRobotSimulator.h
@@ -52,8 +52,9 @@
 /*!
  \class vpRobotSimulator
 
- \ingroup group_robot_simu
- 
+ \ingroup group_robot_simu_gantry group_robot_simu_arm group_robot_simu_unicycle
+ \ingroup group_robot_simu_camera
+
  \brief This class aims to be a basis used to create all the
  robot simulators.
  

diff --git a/modules/robot/include/visp3/robot/vpRobotTemplate.h b/modules/robot/include/visp3/robot/vpRobotTemplate.h
@@ -48,7 +48,7 @@
 
 /*!
  \class vpRobotTemplate
- \ingroup group_robot_real
+ \ingroup group_robot_real_template
  \brief class that defines a robot just to show which function you must implement
 */
 

diff --git a/modules/robot/include/visp3/robot/vpRobotViper650.h b/modules/robot/include/visp3/robot/vpRobotViper650.h
@@ -60,7 +60,7 @@ extern "C" {
 /*!
  \class vpRobotViper650
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_arm
 
  \brief Control of Irisa's Viper S650 robot named Viper650.
 

diff --git a/modules/robot/include/visp3/robot/vpRobotViper850.h b/modules/robot/include/visp3/robot/vpRobotViper850.h
@@ -60,7 +60,7 @@ extern "C" {
 /*!
  \class vpRobotViper850
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_arm
 
  \brief Control of Irisa's Viper S850 robot named Viper850.
 

diff --git a/modules/robot/include/visp3/robot/vpRobotWireFrameSimulator.h b/modules/robot/include/visp3/robot/vpRobotWireFrameSimulator.h
@@ -67,7 +67,7 @@
 /*!
  \class vpRobotWireFrameSimulator
 
- \ingroup group_robot_simu
+ \ingroup group_robot_simu_gantry group_robot_simu_arm
 
  \brief This class aims to be a basis used to create all the
  simulators of robots.

diff --git a/modules/robot/include/visp3/robot/vpServolens.h b/modules/robot/include/visp3/robot/vpServolens.h
@@ -59,7 +59,7 @@
 
  \class vpServolens
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_cylindrical
 
  \brief Interface for the Servolens lens attached to the camera fixed on the 
  Afma4 robot.

diff --git a/modules/robot/include/visp3/robot/vpSimulatorAfma6.h b/modules/robot/include/visp3/robot/vpSimulatorAfma6.h
@@ -53,7 +53,7 @@
 /*!
  \class vpSimulatorAfma6
 
- \ingroup group_robot_simu
+ \ingroup group_robot_simu_gantry
 
  \brief Simulator of Irisa's gantry robot named Afma6.
 

diff --git a/modules/robot/include/visp3/robot/vpSimulatorCamera.h b/modules/robot/include/visp3/robot/vpSimulatorCamera.h
@@ -53,7 +53,7 @@
 /*!
  \class vpSimulatorCamera
 
- \ingroup group_robot_simu
+ \ingroup group_robot_simu_Camera
 
  \brief Class that defines the simplest robot: a free flying camera.
 

diff --git a/modules/robot/include/visp3/robot/vpSimulatorPioneer.h b/modules/robot/include/visp3/robot/vpSimulatorPioneer.h
@@ -54,7 +54,7 @@
 /*!
  \class vpSimulatorPioneer
 
- \ingroup group_robot_simu
+ \ingroup group_robot_simu_unicycle
 
  \brief Class that defines the Pioneer mobile robot simulator equipped with a static camera.
 

diff --git a/modules/robot/include/visp3/robot/vpSimulatorPioneerPan.h b/modules/robot/include/visp3/robot/vpSimulatorPioneerPan.h
@@ -55,7 +55,7 @@
 /*!
  \class vpSimulatorPioneerPan
 
- \ingroup group_robot_simu
+ \ingroup group_robot_simu_unicycle
 
  \brief Class that defines the Pioneer mobile robot simulator equipped
  with a camera able to move in pan.

diff --git a/modules/robot/include/visp3/robot/vpSimulatorViper850.h b/modules/robot/include/visp3/robot/vpSimulatorViper850.h
@@ -53,7 +53,7 @@
 /*!
  \class vpSimulatorViper850
 
- \ingroup group_robot_simu
+ \ingroup group_robot_simu_arm
 
  \brief Simulator of Irisa's Viper S850 robot named Viper850.
 

diff --git a/modules/robot/include/visp3/robot/vpUnicycle.h b/modules/robot/include/visp3/robot/vpUnicycle.h
@@ -46,7 +46,7 @@
 
  \class vpUnicycle
 
- \ingroup group_robot_simu group_robot_simu
+ \ingroup group_robot_simu_unicycle
 
  \brief Generic functions for unicycle mobile robots.
 

diff --git a/modules/robot/include/visp3/robot/vpViper.h b/modules/robot/include/visp3/robot/vpViper.h
@@ -57,7 +57,7 @@
 
  \class vpViper
 
- \ingroup group_robot_real group_robot_simu
+ \ingroup group_robot_real_arm group_robot_simu_arm
 
  \brief Modelisation of the ADEPT Viper robot 
 

diff --git a/modules/robot/include/visp3/robot/vpViper650.h b/modules/robot/include/visp3/robot/vpViper650.h
@@ -50,7 +50,7 @@
 
  \class vpViper650
 
- \ingroup group_robot_real
+ \ingroup group_robot_real_arm
 
  \brief Modelisation of the ADEPT Viper 650 robot.
 

diff --git a/modules/robot/include/visp3/robot/vpViper850.h b/modules/robot/include/visp3/robot/vpViper850.h
@@ -50,7 +50,7 @@
 
  \class vpViper850
 
- \ingroup group_robot_real group_robot_simu
+ \ingroup group_robot_real_arm group_robot_simu_arm
 
  \brief Modelisation of the ADEPT Viper 850 robot.