From 78f6f33bf2200400bcc515d07fe29e21901b2cfd Mon Sep 17 00:00:00 2001 From: cignoni Date: Mon, 20 Sep 2004 09:30:03 +0000 Subject: [PATCH] Better Doxygen docs --- docs/Doxygen/groups.dxy | 11 ++++++----- vcg/complex/edgemesh/base.h | 11 +++++++---- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/Doxygen/groups.dxy b/docs/Doxygen/groups.dxy index 6a4e3527..ce1c6bb4 100644 --- a/docs/Doxygen/groups.dxy +++ b/docs/Doxygen/groups.dxy @@ -1,10 +1,11 @@ /** \defgroup space Space This module contains all the basic types for representing spatial entities like points (vcg::Point3) box3, line planes etc. */ -/** \defgroup vertex Vertex of triangular, tetrahedral meshes This module contains the documentation for the type and the functions used for representing and managing vertexes of meshes. +/** \defgroup vertex Vertex of edge, triangular and tetrahedral meshes This module contains the documentation for the types and the functions used for representing and managing vertexes of meshes. */ -/** \defgroup face Faces -*/ -/** \defgroup trimesh Triangular Meshes This module contains the documentation for the type and the functions used for representing and managing generic \b triangular \b meshes. -*/ /** \defgroup tetramesh Tetrahedral Meshes This module contains the documentation for the type and the functions used for representing and managing generic tetrahedral of meshes. +/** \defgroup face Faces Face of a triangular or a tetrahedral mesh +*/ /** \defgroup edgemesh EdgeMeshes (i.e PolyLines) This module contains the documentation for the types and the functions used for representing and managing generic polylines, or in other words \b edge\b meshes. +*/ + /** \defgroup trimesh Triangular Meshes This module contains the documentation for the types and the functions used for representing and managing generic \b triangular \b meshes. +*/ /** \defgroup tetramesh Tetrahedral Meshes This module contains the documentation for the types and the functions used for representing and managing generic tetrahedral of meshes. */ \ No newline at end of file diff --git a/vcg/complex/edgemesh/base.h b/vcg/complex/edgemesh/base.h index 854c6e20..8ff9913a 100644 --- a/vcg/complex/edgemesh/base.h +++ b/vcg/complex/edgemesh/base.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.2 2004/05/10 14:41:45 ganovelli +name of adhacency function updated + Revision 1.1 2004/04/26 19:10:04 ganovelli created @@ -41,7 +44,7 @@ People should subclass his vertex class from these one... namespace vcg { namespace edge { -/** \addtogroup polyline */ +/** \addtogroup edgemesh */ /*@{*/ /** Class Mesh. @@ -111,12 +114,12 @@ public: inline int MemUsed() const { - return sizeof(Polyline)+sizeof(VertexType)*vert.size()+sizeof(EdgeType)*edges.size(); + return sizeof(EdgeMesh)+sizeof(VertexType)*vert.size()+sizeof(EdgeType)*edges.size(); } inline int MemNeeded() const { - return sizeof(Polyline)+sizeof(VertexType)*vn+sizeof(EdgeType)*fn; + return sizeof(EdgeMesh)+sizeof(VertexType)*vn+sizeof(EdgeType)*fn; } @@ -191,7 +194,7 @@ inline void Mark( ConstEdgePointer f ) const { f->IMark() = imark; } /// Unmark the mesh inline void UnMarkAll() { ++imark; } -}; // end class Polyline +}; // end class EdgeMesh /*@}*/ } // end namespace