Commit e92f9846 authored by Joseph Mirabel's avatar Joseph Mirabel
Browse files

[Doc] Fix doxygen warning

parent d54f7ee8
FILE_PATTERNS = *.h *.hh *.hxx
GENERATE_TREEVIEW = NO
......@@ -47,8 +47,8 @@ namespace fcl
struct CollisionRequest;
/// @defgroup Bounding_Volume
/// regroup class of differents types of bounding volume.
/// @defgroup Bounding_Volume Bounding volumes
/// Classes of different types of bounding volume.
/// @{
/// @brief A class describing the AABB collision structure, which is a box in 3D space determined by two diagonal points
......
......@@ -49,8 +49,8 @@ namespace hpp
namespace fcl
{
/// @defgroup Construction_Of_BVH
/// regroup class which are used to build BVH (Bounding Volume Hierarchy)
/// @defgroup Construction_Of_BVH Construction of BVHModel
/// Classes which are used to build a BVHModel (Bounding Volume Hierarchy)
/// @{
/// @brief BVNodeBase encodes the tree structure for BVH
......
......@@ -158,9 +158,10 @@ inline bool overlap(const Matrix3f& R0, const Vec3f& T0, const OBBRSS& b1, const
}
/// Check collision between two OBBRSS
/// @param R0, T0 configuration of b1
/// @param b1 first OBBRSS in configuration (R0, T0)
/// @param b2 second OBBRSS in identity position
/// @retval squared lower bound on the distance if OBBRSS do not overlap.
/// @retval sqrDistLowerBound squared lower bound on the distance if OBBRSS do not overlap.
inline bool overlap(const Matrix3f& R0, const Vec3f& T0, const OBBRSS& b1,
const OBBRSS& b2, const CollisionRequest& request,
FCL_REAL& sqrDistLowerBound)
......
......@@ -250,6 +250,7 @@ protected:
};
/// @brief A class describing the bounding hierarchy of a mesh model or a point cloud model (which is viewed as a degraded version of mesh)
/// \tparam BV one of the bounding volume class in \ref Bounding_Volume.
template<typename BV>
class BVHModel : public BVHModelBase
{
......
......@@ -288,7 +288,7 @@ struct DistanceRequest
FCL_REAL rel_err; // relative error, between 0 and 1
FCL_REAL abs_err; // absoluate error
/// \deprected the last argument should be removed.
/// \deprecated the last argument should be removed.
DistanceRequest(bool enable_nearest_points_,
FCL_REAL rel_err_,
FCL_REAL abs_err_,
......
......@@ -95,7 +95,7 @@ public:
vids[0] = p1; vids[1] = p2; vids[2] = p3;
}
/// @access the triangle index
/// @brief Access the triangle index
inline index_type operator[](int i) const { return vids[i]; }
inline index_type& operator[](int i) { return vids[i]; }
......
......@@ -47,5 +47,5 @@
/// \par Using hpp-fcl
///
/// The main entry points to the library are functions
/// \li hpp::fcl::collide and
/// \li hpp::fcl::distance.
/// \li hpp::fcl::collide(const CollisionObject*, const CollisionObject*, const CollisionRequest&, CollisionResult&)
/// \li hpp::fcl::distance(const CollisionObject*, const CollisionObject*, const DistanceRequest&, DistanceResult&)
......@@ -75,7 +75,6 @@ struct Loader {
*
* @param[in] scale Scale to apply when reading the ressource
* @param[in] scene Pointer to the assimp scene
* @param[in] node Current node of the scene
* @param[in] vertices_offset Current number of vertices in the model
* @param tv Triangles and Vertices of the mesh submodels
*/
......
......@@ -46,15 +46,15 @@ namespace hpp
namespace fcl
{
/// @brief Convex polytope
/// @brief Convex polytope
/// @tparam PolygonT the polygon class. It must have method \c size() and
/// \c operator[](int i)
template <typename PolygonT>
class Convex : public ConvexBase
{
public:
/// @brief Constructing a convex, providing normal and offset of each polytype surface, and the points and shape topology information
/// \param own_storage whether this class owns the pointers of points and
/// @brief Constructing a convex, providing normal and offset of each polytype surface, and the points and shape topology information
/// \param ownStorage whether this class owns the pointers of points and
/// polygons. If owned, they are deleted upon destruction.
/// \param points_ list of 3D points
/// \param num_points_ number of 3D points
......
......@@ -62,8 +62,8 @@ public:
OBJECT_TYPE getObjectType() const { return OT_GEOM; }
};
/// @defgroup Geometric_Shapes
/// regroup class of differents types of geometric shapes.
/// @defgroup Geometric_Shapes Geometric shapes
/// Classes of different types of geometric shapes.
/// @{
/// @brief Triangle stores the points instead of only indices of points
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment