From b4aa978d4b3e5854ce9e4b7e602767fe2d542b93 Mon Sep 17 00:00:00 2001 From: vahrenkamp <vahrenkamp@042f3d55-54a8-47e9-b7fb-15903f145c44> Date: Thu, 17 May 2012 20:35:37 +0000 Subject: [PATCH] Documentation fixes. git-svn-id: http://svn.code.sf.net/p/simox/code/trunk@251 042f3d55-54a8-47e9-b7fb-15903f145c44 --- MotionPlanning/CSpace/CSpace.h | 2 +- MotionPlanning/Planner/GraspRrt.h | 8 ++++++-- VirtualRobot/EndEffector/EndEffector.cpp | 2 +- VirtualRobot/EndEffector/EndEffectorActor.cpp | 2 +- VirtualRobot/Grasping/Grasp.h | 3 ++- VirtualRobot/LinkedCoordinate.h | 4 ++-- VirtualRobot/Nodes/RobotNodeFixedFactory.cpp | 2 +- VirtualRobot/Nodes/RobotNodePrismaticFactory.cpp | 2 +- VirtualRobot/Nodes/RobotNodeRevoluteFactory.cpp | 2 +- VirtualRobot/RobotConfig.h | 4 ++-- VirtualRobot/Transformation/Transformation.cpp | 2 +- .../Transformation/tests/DHParameterTest.cpp | 2 +- .../Transformation/tests/TransformationTest.cpp | 2 +- .../CoinVisualization/CoinVisualization.cpp | 2 +- .../CoinVisualization/CoinVisualizationFactory.cpp | 2 +- .../CoinVisualization/CoinVisualizationNode.cpp | 2 +- .../tests/CoinVisualizationFactoryTest.cpp | 2 +- VirtualRobot/Visualization/TriMeshModel.cpp | 2 +- VirtualRobot/Visualization/Visualization.cpp | 2 +- VirtualRobot/Visualization/VisualizationNode.cpp | 2 +- .../Visualization/tests/TriMeshModelTest.cpp | 2 +- VirtualRobot/Workspace/VoxelTree6D.hpp | 7 ------- VirtualRobot/Workspace/WorkspaceRepresentation.h | 1 + VirtualRobot/XML/BaseIO.cpp | 4 ++-- VirtualRobot/XML/ObjectIO.h | 1 + VirtualRobot/XML/RobotIO.cpp | 12 ++++++------ VirtualRobot/XML/RobotIO.h | 3 ++- VirtualRobot/XML/SceneIO.h | 1 + VirtualRobot/tests/VirtualRobotExceptionTest.cpp | 2 +- .../tests/VirtualRobotLinkedCoordinateTest.cpp | 2 +- VirtualRobot/tests/VirtualRobotThreadsafetyTest.cpp | 2 +- doc/CMakeLists.txt | 3 +++ doc/Doxyfile.in | 2 +- 33 files changed, 49 insertions(+), 44 deletions(-) diff --git a/MotionPlanning/CSpace/CSpace.h b/MotionPlanning/CSpace/CSpace.h index 1844807c6..aa7b0b697 100644 --- a/MotionPlanning/CSpace/CSpace.h +++ b/MotionPlanning/CSpace/CSpace.h @@ -140,7 +140,7 @@ public: \param storeValues Store the values here. \param checkValid When set to true, it is guaranteed that the sample not in collision and all constraints are considered */ - void getRandomConfig(Eigen::VectorXf &storeValues, bool checkvalid = false); + void getRandomConfig(Eigen::VectorXf &storeValues, bool checkValid = false); //! set values of configuration considering boundaries virtual void respectBoundaries(Eigen::VectorXf &config); diff --git a/MotionPlanning/Planner/GraspRrt.h b/MotionPlanning/Planner/GraspRrt.h index a63af0bb8..d93135741 100644 --- a/MotionPlanning/Planner/GraspRrt.h +++ b/MotionPlanning/Planner/GraspRrt.h @@ -162,6 +162,10 @@ public: /*! Computes a step towards goalPose. + \param currentPose The current pose + \param goalPose The pose in global coord system. + \param storeCSpaceConf The result is stored here. + \return The resulting state. */ MoveArmResult createWorkSpaceSamplingStep(const Eigen::Matrix4f ¤tPose, const Eigen::Matrix4f &goalPose, Eigen::VectorXf &storeCSpaceConf); @@ -214,8 +218,8 @@ protected: /*! Current pose of RNS is moved. - \param deltaPose Consists of the 3x3 rotation delta R and the 3 dim translational delta T in homogeneous notation. - R and T must be given in global coordinate system. + \param deltaPose Consists of the 3x3 rotation delta R and the 3 dim translational delta T in homogeneous notation. R and T must be given in global coordinate system. + \param storeCSpaceConf The result is stored here. */ MoveArmResult moveArmDiffKin(const Eigen::Matrix4f &deltaPose, Eigen::VectorXf &storeCSpaceConf); diff --git a/VirtualRobot/EndEffector/EndEffector.cpp b/VirtualRobot/EndEffector/EndEffector.cpp index 116557e98..2fe0c1cca 100644 --- a/VirtualRobot/EndEffector/EndEffector.cpp +++ b/VirtualRobot/EndEffector/EndEffector.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net>, Nikolaus Vahrenkamp +* @author Manfred Kroehnert , Nikolaus Vahrenkamp * @copyright 2011 Manfred Kroehnert, Nikolaus Vahrenkamp */ diff --git a/VirtualRobot/EndEffector/EndEffectorActor.cpp b/VirtualRobot/EndEffector/EndEffectorActor.cpp index 4e060e406..9bfd31bf1 100644 --- a/VirtualRobot/EndEffector/EndEffectorActor.cpp +++ b/VirtualRobot/EndEffector/EndEffectorActor.cpp @@ -1,7 +1,7 @@ /** * @package VirtualRobot * @author Nikolaus Vahrenkamp -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2011 Manfred Kroehnert */ diff --git a/VirtualRobot/Grasping/Grasp.h b/VirtualRobot/Grasping/Grasp.h index 6bca480a1..ebc77db1e 100644 --- a/VirtualRobot/Grasping/Grasp.h +++ b/VirtualRobot/Grasping/Grasp.h @@ -49,8 +49,9 @@ public: \param poseInTCPCoordSystem The pose of the object, given in eef's tcp coordinate system \param creation A custom string explaining how the grasp was created. \param quality A custom quality index. + \param eefPreshape An optional preshape. */ - Grasp(const std::string &name, const std::string &robotType, const std::string &eef, const Eigen::Matrix4f &poseInTCPCoordSystem, const std::string &creation= std::string(""), float quality = 0.0f, const std::string &eefPreshape= std::string("")); + Grasp(const std::string &name, const std::string &robotType, const std::string &eef, const Eigen::Matrix4f &poseInTCPCoordSystem, const std::string &creation= std::string(""), float quality = 0.0f, const std::string &eefPreshape = std::string("")); /*! */ diff --git a/VirtualRobot/LinkedCoordinate.h b/VirtualRobot/LinkedCoordinate.h index 624db1929..cfeef3448 100644 --- a/VirtualRobot/LinkedCoordinate.h +++ b/VirtualRobot/LinkedCoordinate.h @@ -15,7 +15,7 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. * * @package VirtualRobot -* @author Stefan Ulbrich <stefanulbrich at users dot sf dot net> +* @author Stefan Ulbrich * @copyright 2011 Stefan Ulbrich * @license http://www.gnu.org/licenses/gpl.txt * GNU General Public License @@ -90,7 +90,7 @@ public: /** Sets the frame of reference and the coordinate relative to it. * @param frame The name of the robot node that defines the reference frame of the coordinate. - * @param pose A homogeneous matrix that defines the pose relative to the frame of reference. + * @param position The pose relative to the frame of reference. * @throw VirtualRobotException An exception is thrown if frame does not belong to the robot. * @details A homogeneous vector can be previously converted using Eigen::Vector4f::head<3>(). */ diff --git a/VirtualRobot/Nodes/RobotNodeFixedFactory.cpp b/VirtualRobot/Nodes/RobotNodeFixedFactory.cpp index 95be27945..aecd47cbd 100644 --- a/VirtualRobot/Nodes/RobotNodeFixedFactory.cpp +++ b/VirtualRobot/Nodes/RobotNodeFixedFactory.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Nodes/RobotNodePrismaticFactory.cpp b/VirtualRobot/Nodes/RobotNodePrismaticFactory.cpp index 2869b7cab..b8b324252 100644 --- a/VirtualRobot/Nodes/RobotNodePrismaticFactory.cpp +++ b/VirtualRobot/Nodes/RobotNodePrismaticFactory.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Nodes/RobotNodeRevoluteFactory.cpp b/VirtualRobot/Nodes/RobotNodeRevoluteFactory.cpp index 18c499245..42a3b0bc1 100644 --- a/VirtualRobot/Nodes/RobotNodeRevoluteFactory.cpp +++ b/VirtualRobot/Nodes/RobotNodeRevoluteFactory.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/RobotConfig.h b/VirtualRobot/RobotConfig.h index 5f78ab4b3..2aa98b85d 100644 --- a/VirtualRobot/RobotConfig.h +++ b/VirtualRobot/RobotConfig.h @@ -81,7 +81,7 @@ public: /*! Appends a configuration to this instance. - \param True on success. False if robot is not present any more (may happen due to the use of weak pointers). + \return True on success. False if robot is not present any more (may happen due to the use of weak pointers). */ bool setConfig (const Configuration &c); bool setConfig (RobotNodePtr node, float value); @@ -90,7 +90,7 @@ public: /*! Apply the stored configurations to the corresponding robot. RobotNodes that are not stored in this RobotConfig are not affected. - \param True on success. False if robot is not present any more (may happen due to the use of weak pointers). + \return True on success. False if robot is not present any more (may happen due to the use of weak pointers). */ bool setJointValues(); diff --git a/VirtualRobot/Transformation/Transformation.cpp b/VirtualRobot/Transformation/Transformation.cpp index d99c41bda..3e275fa34 100644 --- a/VirtualRobot/Transformation/Transformation.cpp +++ b/VirtualRobot/Transformation/Transformation.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Transformation/tests/DHParameterTest.cpp b/VirtualRobot/Transformation/tests/DHParameterTest.cpp index 9d8984660..b74a13b87 100644 --- a/VirtualRobot/Transformation/tests/DHParameterTest.cpp +++ b/VirtualRobot/Transformation/tests/DHParameterTest.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Transformation/tests/TransformationTest.cpp b/VirtualRobot/Transformation/tests/TransformationTest.cpp index 6f29a6131..5223e9271 100644 --- a/VirtualRobot/Transformation/tests/TransformationTest.cpp +++ b/VirtualRobot/Transformation/tests/TransformationTest.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Visualization/CoinVisualization/CoinVisualization.cpp b/VirtualRobot/Visualization/CoinVisualization/CoinVisualization.cpp index dffc7d617..c0fe7515a 100644 --- a/VirtualRobot/Visualization/CoinVisualization/CoinVisualization.cpp +++ b/VirtualRobot/Visualization/CoinVisualization/CoinVisualization.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Visualization/CoinVisualization/CoinVisualizationFactory.cpp b/VirtualRobot/Visualization/CoinVisualization/CoinVisualizationFactory.cpp index d39caf6ae..6d06955c8 100644 --- a/VirtualRobot/Visualization/CoinVisualization/CoinVisualizationFactory.cpp +++ b/VirtualRobot/Visualization/CoinVisualization/CoinVisualizationFactory.cpp @@ -1,7 +1,7 @@ /** * @package VirtualRobot * @author Nikolaus Vahrenkamp -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010,2011 Nikolaus Vahrenkamp, Manfred Kroehnert */ diff --git a/VirtualRobot/Visualization/CoinVisualization/CoinVisualizationNode.cpp b/VirtualRobot/Visualization/CoinVisualization/CoinVisualizationNode.cpp index 69af4c86d..7fd426c33 100644 --- a/VirtualRobot/Visualization/CoinVisualization/CoinVisualizationNode.cpp +++ b/VirtualRobot/Visualization/CoinVisualization/CoinVisualizationNode.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Visualization/CoinVisualization/tests/CoinVisualizationFactoryTest.cpp b/VirtualRobot/Visualization/CoinVisualization/tests/CoinVisualizationFactoryTest.cpp index 91ccf0ebc..274735be2 100644 --- a/VirtualRobot/Visualization/CoinVisualization/tests/CoinVisualizationFactoryTest.cpp +++ b/VirtualRobot/Visualization/CoinVisualization/tests/CoinVisualizationFactoryTest.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Visualization/TriMeshModel.cpp b/VirtualRobot/Visualization/TriMeshModel.cpp index 1d77bb636..fce60b82b 100644 --- a/VirtualRobot/Visualization/TriMeshModel.cpp +++ b/VirtualRobot/Visualization/TriMeshModel.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Visualization/Visualization.cpp b/VirtualRobot/Visualization/Visualization.cpp index e44b58a93..8c9b865c3 100644 --- a/VirtualRobot/Visualization/Visualization.cpp +++ b/VirtualRobot/Visualization/Visualization.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Visualization/VisualizationNode.cpp b/VirtualRobot/Visualization/VisualizationNode.cpp index 4068e4c87..0f3f4dbe1 100644 --- a/VirtualRobot/Visualization/VisualizationNode.cpp +++ b/VirtualRobot/Visualization/VisualizationNode.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @author Nikolaus Vahrenkamp * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Visualization/tests/TriMeshModelTest.cpp b/VirtualRobot/Visualization/tests/TriMeshModelTest.cpp index 00169cf50..881df0bc0 100644 --- a/VirtualRobot/Visualization/tests/TriMeshModelTest.cpp +++ b/VirtualRobot/Visualization/tests/TriMeshModelTest.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/Workspace/VoxelTree6D.hpp b/VirtualRobot/Workspace/VoxelTree6D.hpp index 89582db5d..e95cb38e8 100644 --- a/VirtualRobot/Workspace/VoxelTree6D.hpp +++ b/VirtualRobot/Workspace/VoxelTree6D.hpp @@ -117,13 +117,6 @@ public: return root->getEntry(pos); } - - /*! - Check if the corresponding leaf is present in data structure. - \Return False if p is outside the extends or if no data is stored for pos - */ - //bool isCovered(float pos[6]); - protected: float minExtend[6]; float maxExtend[6]; diff --git a/VirtualRobot/Workspace/WorkspaceRepresentation.h b/VirtualRobot/Workspace/WorkspaceRepresentation.h index 184a96485..6427a7f72 100644 --- a/VirtualRobot/Workspace/WorkspaceRepresentation.h +++ b/VirtualRobot/Workspace/WorkspaceRepresentation.h @@ -137,6 +137,7 @@ public: /*! Generate a random configuration for the robot node set. This configuration is within the joint limits of the current robot node set. + \param nodeSet The nodes. \param checkForSelfCollisions Build a collision-free configuration. If true, random configs are generated until one is collision-free. */ virtual bool setRobotNodesToRandomConfig(VirtualRobot::RobotNodeSetPtr nodeSet, bool checkForSelfCollisions = true); diff --git a/VirtualRobot/XML/BaseIO.cpp b/VirtualRobot/XML/BaseIO.cpp index fa1a2af94..cd9636fae 100644 --- a/VirtualRobot/XML/BaseIO.cpp +++ b/VirtualRobot/XML/BaseIO.cpp @@ -144,7 +144,7 @@ Eigen::Matrix3f BaseIO::process3x3Matrix(rapidxml::xml_node<char> *matrixXMLNode /** - * This method processes <Transform> tags. + * This method processes \<Transform\> tags. * If \p transformXMLNode is NULL (e.g. the tag does not exist) \p transform * is set to contain the identity matrix. */ @@ -436,7 +436,7 @@ void BaseIO::getLowerCase(std::string& aString) /** - * This method processes the \p parentNode Tag and extracts a list of <Node name="xyz"/> tags. + * This method processes the \p parentNode Tag and extracts a list of \<Node name="xyz"/\> tags. * All other child tags raise a VirtualRobot::VirtualRobotException. * The resulting nodes are stored in \p nodeList. * diff --git a/VirtualRobot/XML/ObjectIO.h b/VirtualRobot/XML/ObjectIO.h index 846b54789..e1d737983 100644 --- a/VirtualRobot/XML/ObjectIO.h +++ b/VirtualRobot/XML/ObjectIO.h @@ -59,6 +59,7 @@ public: /*! Creates ManipulationObject from string. + @param xmlString The input string. @param basePath If file tags are given, the base path for searching the object files can be specified. */ static ManipulationObjectPtr createManipulationObjectFromString(const std::string &xmlString, const std::string &basePath = ""); diff --git a/VirtualRobot/XML/RobotIO.cpp b/VirtualRobot/XML/RobotIO.cpp index 8a251536d..00a729185 100644 --- a/VirtualRobot/XML/RobotIO.cpp +++ b/VirtualRobot/XML/RobotIO.cpp @@ -73,7 +73,7 @@ void RobotIO::processChildFromRobotNode(rapidxml::xml_node<char> *childXMLNode, /** - * This method processes <Limits> tags. + * This method processes Limits tags. * The values for the attributes "lo" and "hi" are extracted based on the * "unit" or "units" attribute. * @@ -847,8 +847,8 @@ EndEffectorPtr RobotIO::processEndeffectorNode(rapidxml::xml_node<char>* endeffe /** - * This method processes the attributes and the children of an <actor> tag which - * itself is a child of the <endeffector> tag. + * This method processes the attributes and the children of an actor tag which + * itself is a child of the endeffector tag. * First the name attribute is retrieved and afterwards the child nodes are * processed which make up the actor. */ @@ -865,8 +865,8 @@ EndEffectorActorPtr RobotIO::processEndeffectorActorNode(rapidxml::xml_node<char /** - * This method processes the children of the <static> tag which - * itself is a child of the <endeffector> tag. + * This method processes the children of the static tag which + * itself is a child of the endeffector tag. */ void RobotIO::processEndeffectorStaticNode(rapidxml::xml_node<char>* endeffectorStaticXMLNode, RobotPtr robo, std::vector<RobotNodePtr>& staticNodesList) { @@ -875,7 +875,7 @@ void RobotIO::processEndeffectorStaticNode(rapidxml::xml_node<char>* endeffector /** - * This method processes the \p parentNode Tag and extracts a list of <Node name="xyz" speed="0123" /> tags. + * This method processes the \p parentNode Tag and extracts a list of \<Node name="xyz" speed="0123" /\> tags. * All other child tags raise a VirtualRobot::VirtualRobotException. * The resulting nodes are stored in \p nodeList. * diff --git a/VirtualRobot/XML/RobotIO.h b/VirtualRobot/XML/RobotIO.h index 4966de218..d563ddb87 100644 --- a/VirtualRobot/XML/RobotIO.h +++ b/VirtualRobot/XML/RobotIO.h @@ -68,7 +68,8 @@ public: /*! Creates Robot from string. - @param basePath If any <childFromRobot> tags are given, the path for searching the robot files can be specified. + @param xmlString The input string. + @param basePath If any \<childFromRobot\> tags are given, the path for searching the robot files can be specified. @param loadMode Standard: eFull, When eStructure is used no visualization oand collision models are loaded for faster access. */ static RobotPtr createRobotFromString(const std::string &xmlString, const std::string &basePath = "", RobotDescription loadMode = eFull); diff --git a/VirtualRobot/XML/SceneIO.h b/VirtualRobot/XML/SceneIO.h index 5c66d17b9..933ad8da9 100644 --- a/VirtualRobot/XML/SceneIO.h +++ b/VirtualRobot/XML/SceneIO.h @@ -58,6 +58,7 @@ public: /*! Creates scene from string. + \param xmlString The input. \param basePath If any robot tags are given, the base path for searching the robot files can be specified. */ static ScenePtr createSceneFromString(const std::string &xmlString, const std::string &basePath = ""); diff --git a/VirtualRobot/tests/VirtualRobotExceptionTest.cpp b/VirtualRobot/tests/VirtualRobotExceptionTest.cpp index 29dc953d1..7aa35187f 100644 --- a/VirtualRobot/tests/VirtualRobotExceptionTest.cpp +++ b/VirtualRobot/tests/VirtualRobotExceptionTest.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Manfred Kroehnert <mkroehnert _at_ users dot sourceforge dot net> +* @author Manfred Kroehnert * @copyright 2010 Manfred Kroehnert */ diff --git a/VirtualRobot/tests/VirtualRobotLinkedCoordinateTest.cpp b/VirtualRobot/tests/VirtualRobotLinkedCoordinateTest.cpp index 214befe98..c3ce4c8ae 100644 --- a/VirtualRobot/tests/VirtualRobotLinkedCoordinateTest.cpp +++ b/VirtualRobot/tests/VirtualRobotLinkedCoordinateTest.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Stefan Ulbrich <stefanulbrich at users dot sf dot net>, Nikolaus Vahrenkamp +* @author Stefan Ulbrich, Nikolaus Vahrenkamp * @copyright 2010,2011 Stefan Ulbrich, Nikolaus Vahrenkamp */ diff --git a/VirtualRobot/tests/VirtualRobotThreadsafetyTest.cpp b/VirtualRobot/tests/VirtualRobotThreadsafetyTest.cpp index 7bd0135fc..544af0b8c 100644 --- a/VirtualRobot/tests/VirtualRobotThreadsafetyTest.cpp +++ b/VirtualRobot/tests/VirtualRobotThreadsafetyTest.cpp @@ -1,6 +1,6 @@ /** * @package VirtualRobot -* @author Stefan Ulbrich <stefanulbrich at users dot sf dot net>, Nikolaus Vahrenkamp +* @author Stefan Ulbrich, Nikolaus Vahrenkamp * @copyright 2010,2011,2012 Stefan Ulbrich, Nikolaus Vahrenkamp */ diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index a17a53684..8709d98e7 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -46,6 +46,9 @@ IF(DOXYGEN_FOUND) # set image path SET (CMAKE_DOXYGEN_IMAGE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/images") + # set exclude files + SET (CMAKE_EXCLUDE_LIST "${CMAKE_CURRENT_SOURCE_DIR}/../VirtualRobot/XML/rapidxml.hpp") + # replace ; with space STRING(REGEX REPLACE ";" " " DOXYGEN_INPUT_DIRECTORIES "${CMAKE_DOXYGEN_INPUT_LIST}") diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 91117fc5e..767647c0b 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -701,7 +701,7 @@ RECURSIVE = NO # subdirectory from a directory tree whose root is specified with the INPUT tag. # Note that relative paths are relative to directory from which doxygen is run. -EXCLUDE = rapidxml.hpp +EXCLUDE = @CMAKE_EXCLUDE_LIST@ # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded -- GitLab