Better Doxygen docs

This commit is contained in:
Paolo Cignoni 2004-09-20 08:37:57 +00:00
parent 92fa5a7e4a
commit cca63f6527
2 changed files with 17 additions and 10 deletions

View File

@ -24,6 +24,9 @@
History
$Log: not supported by cvs2svn $
Revision 1.2 2004/05/10 14:41:25 ganovelli
name of adhacency function updated
****************************************************************************/
@ -33,10 +36,10 @@ $Log: not supported by cvs2svn $
namespace vcg {
namespace edge {
/** \addtogroup trimesh */
/** \addtogroup edgemesh */
/*@{*/
/// Class to safely add vertexes and faces to a mesh updating all the involved pointers.
/// It provides static memeber to add either vertex or faces to a trimesh.
/// It provides static memeber to add either vertex or faces to a edgemesh.
template <class AllocateMeshType>
class Allocator
{

View File

@ -24,6 +24,9 @@
History
$Log: not supported by cvs2svn $
Revision 1.4 2004/08/25 15:15:26 ganovelli
minor changes to comply gcc compiler (typename's and stuff)
Revision 1.3 2004/07/18 06:55:37 cignoni
NewUserBit -> NewBitFlag
@ -46,11 +49,9 @@ Initial Release
namespace vcg {
namespace tri {
///
/** This function removes all duplicate vertices of the mesh by looking only at their spatial positions.
Note that it does not update any topology relation that could be affected by this like the VT or TT relation.
the reason this function is usually performed BEFORE building any topology information.
*/
/** \addtogroup trimesh */
/*@{*/
/// Class of static functions to clean/correct/restore meshs.
template <class CleanMeshType>
class Clean
{
@ -72,6 +73,10 @@ public:
}
};
/** This function removes all duplicate vertices of the mesh by looking only at their spatial positions.
Note that it does not update any topology relation that could be affected by this like the VT or TT relation.
the reason this function is usually performed BEFORE building any topology information.
*/
static int RemoveDuplicateVertex( MeshType & m ) // V1.0
{
if(m.vert.size()==0 || m.vn==0) return 0;
@ -125,8 +130,7 @@ static int RemoveDuplicateVertex( MeshType & m ) // V1.0
}
/** This function removes all vertices not pertaining to nobody face. La funzione aggiorna
la variabile vn della classe mesh che contiene il numero di vertici.
/** This function removes that are not referenced by any face. The function updates the vn counter.
@param m The mesh
@return The number of removed vertices
*/
@ -160,7 +164,7 @@ static int RemoveUnreferencedVertex( CleanMeshType& m ) // V1.0
}; // end class
/*@}*/
} // End Namespace TriMesh
} // End Namespace vcg
#endif