fixed doxygen comments according to the new vcg's doxygen comments style (please look at doxygen-comments-style.txt in the vcgrootfolder/docs)

This commit is contained in:
granzuglia 2008-05-28 13:28:09 +00:00
parent 45ed8cb000
commit f0373b8ebb
1 changed files with 29 additions and 15 deletions

View File

@ -93,10 +93,11 @@ Initial commit
#include <vcg/simplex/face/pos.h> #include <vcg/simplex/face/pos.h>
namespace vcg { namespace vcg {
namespace tri { namespace tri {
/** \addtogroup trimesh */ /// \ingroup trimesh
/*@{*/
/** Generation of per-vertex and per-face topological information. /// \headerfile topology.h vcg/complex/trimesh/update/topology.h
**/
/// \brief Generation of per-vertex and per-face topological information.
template <class UpdateMeshType> template <class UpdateMeshType>
class UpdateTopology class UpdateTopology
@ -112,9 +113,13 @@ typedef typename MeshType::FacePointer FacePointer;
typedef typename MeshType::FaceIterator FaceIterator; typedef typename MeshType::FaceIterator FaceIterator;
/// \headerfile topology.h vcg/complex/trimesh/update/topology.h
/// \brief Auxiliairy data structure for computing face face adjacency information.
/**
It identifies and edge storing two vertex pointer and a face pointer where it belong.
*/
/// Auxiliairy data structure for computing face face adjacency information.
// It identifies and edge storing two vertex pointer and a face pointer where it belong.
class PEdge class PEdge
{ {
public: public:
@ -170,8 +175,7 @@ static void FillEdgeVector(MeshType &m, std::vector<PEdge> &e)
assert(p==e.end()); assert(p==e.end());
} }
/** Update the Face-Face topological relation by allowing to retrieve for each face what other faces shares their edges. /// \brief Update the Face-Face topological relation by allowing to retrieve for each face what other faces shares their edges.
*/
static void FaceFace(MeshType &m) static void FaceFace(MeshType &m)
{ {
if(!m.HasFFTopology()) return; if(!m.HasFFTopology()) return;
@ -215,8 +219,11 @@ static void FaceFace(MeshType &m)
} }
/** Update the Vertex-Face topological relation by allowing to retrieve for each vertex the list of faces sharing this vertex.. /// \brief Update the Vertex-Face topological relation.
/**
The function allows to retrieve for each vertex the list of faces sharing this vertex.
*/ */
static void VertexFace(MeshType &m) static void VertexFace(MeshType &m)
{ {
if(!m.HasVFTopology()) return; if(!m.HasVFTopology()) return;
@ -244,9 +251,13 @@ static void VertexFace(MeshType &m)
} }
/// \headerfile topology.h vcg/complex/trimesh/update/topology.h
/// \brief Auxiliairy data structure for computing face face adjacency information.
/**
It identifies and edge storing two vertex pointer and a face pointer where it belong.
*/
/// Auxiliairy data structure for computing face face adjacency information.
// It identifies and edge storing two vertex pointer and a face pointer where it belong.
class PEdgeTex class PEdgeTex
{ {
public: public:
@ -290,8 +301,12 @@ inline bool operator != ( const PEdgeTex & pe ) const
}; };
/** Update the Face-Face topological relation by allowing to retrieve for each face what other faces shares their edges. /// \brief Update the Face-Face topological relation
/**
The function allows to retrieve for each face what other faces shares their edges.
*/ */
static void FaceFaceFromTexCoord(MeshType &m) static void FaceFaceFromTexCoord(MeshType &m)
{ {
// assert(HasFFTopology(m)); // assert(HasFFTopology(m));
@ -352,7 +367,7 @@ static void FaceFaceFromTexCoord(MeshType &m)
///test correctness of VFtopology /// \brief Test correctness of VFtopology
static void TestVertexFace(MeshType &m) static void TestVertexFace(MeshType &m)
{ {
if(!m.HasVFTopology()) return; if(!m.HasVFTopology()) return;
@ -379,7 +394,7 @@ static void TestVertexFace(MeshType &m)
} }
} }
///test correctness of FFtopology /// \brief Test correctness of FFtopology
static void TestFaceFace(MeshType &m) static void TestFaceFace(MeshType &m)
{ {
if(!m.HasFFTopology()) return; if(!m.HasFFTopology()) return;
@ -413,7 +428,6 @@ static void TestFaceFace(MeshType &m)
}; // end class }; // end class
/*@}*/
} // End namespace } // End namespace
} // End namespace } // End namespace