From 5bd4d8b2b112834e36bdfd5bb703fbf7345487a0 Mon Sep 17 00:00:00 2001 From: cignoni Date: Thu, 28 Oct 2004 00:56:44 +0000 Subject: [PATCH] Better Doxygen documentation --- docs/Doxygen/groups.dxy | 19 ++++++++++++------- docs/Doxygen/vcg.css | 2 +- vcg/complex/edgemesh/allocate.h | 14 ++++++++------ vcg/complex/edgemesh/base.h | 13 ++++++------- vcg/complex/edgemesh/update/topology.h | 5 ++++- vcg/complex/tetramesh/update/normal.h | 5 ++++- vcg/complex/tetramesh/update/triconvert.h | 1 - vcg/complex/trimesh/base.h | 11 +++++++---- vcg/complex/trimesh/edge_collapse.h | 5 +++-- vcg/complex/trimesh/platonic.h | 7 ++++++- vcg/simplex/face/base.h | 22 +++++++++++++--------- vcg/simplex/face/pos.h | 5 ++++- vcg/simplex/tetrahedron/pos.h | 4 +--- vcg/simplex/vertex/base.h | 23 +++++++++++++++-------- wrap/io_trimesh/export_ply.h | 5 ++++- wrap/io_trimesh/export_stl.h | 4 +++- wrap/io_trimesh/import_stl.h | 6 +++--- wrap/io_trimesh/io_mask.h | 12 ++++++++---- 18 files changed, 102 insertions(+), 61 deletions(-) diff --git a/docs/Doxygen/groups.dxy b/docs/Doxygen/groups.dxy index 96d009a2..53d5527e 100644 --- a/docs/Doxygen/groups.dxy +++ b/docs/Doxygen/groups.dxy @@ -1,13 +1,18 @@ + + /** \defgroup space Space -This module contains all the basic types for representing spatial entities like points (vcg::Point3) box3, line planes etc. This module contains the documentation for the types and the functions used for... - */ -/** \defgroup vertex Vertexes 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. +This module contains all the basic types for representing spatial entities like points (vcg::Point3) box3, line planes etc. This module contains the documentation for the types and the functions used for... */ + /** \defgroup math Math This module contains the documentation for the types and the functions used for representing and managing mathematical entities. +*/ + /** \defgroup simplex Simplexes The moudule containing the various simplicial complexes +*/ //@{ +/** \defgroup vertex Vertexes 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 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 tetra Tetrahedra Tetrahedral element of a tetrahedral complex. +*/ //@} /** \defgroup complex Complexes The moudule containing the various simplicial complexes +*/ //@{ /** \defgroup edgemesh Edge Meshes (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. -*/ /** \defgroup math Math This module contains the documentation for the types and the functions used for representing and managing mathematical entities. - -*/ \ No newline at end of file +*/ //@} \ No newline at end of file diff --git a/docs/Doxygen/vcg.css b/docs/Doxygen/vcg.css index 9b7d1f03..2ef1dc3d 100644 --- a/docs/Doxygen/vcg.css +++ b/docs/Doxygen/vcg.css @@ -51,7 +51,7 @@ A.qindexHL:hover { padding: 2px 6px; } A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff } -A.el { text-decoration: none; font-weight: bold; font-size: 80%; +A.el { text-decoration: none; font-weight: bold; font-size: 100%; } A.elRef { font-weight: bold } A.code { text-decoration: none; font-weight: normal; color: #1A419D} diff --git a/vcg/complex/edgemesh/allocate.h b/vcg/complex/edgemesh/allocate.h index 36684e39..f8f081d6 100644 --- a/vcg/complex/edgemesh/allocate.h +++ b/vcg/complex/edgemesh/allocate.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.3 2004/09/20 08:37:47 cignoni +Better Doxygen docs + Revision 1.2 2004/05/10 14:41:25 ganovelli name of adhacency function updated @@ -77,12 +80,11 @@ public: }; -/** Function to add n vertices to the mesh. The second parameter hold a vector of - pointers to pointer to elements of the mesh that should be updated after a - possible vector realloc. - @param n Il numero di vertici che si vuole aggiungere alla mesh. - @param local_var Vettore di variabili locali che rappresentano puntatori a vertici. - restituisce l'iteratore al primo elemento aggiunto. +/** Function to safely add n vertices to a mesh. + + @param m The mesh to be expanded + @param n the number of vertexes to be added + @param pu A PointerUpdater that stores the relocation that can be happened. */ static VertexIterator AddVertices(MeshType &m,int n, PointerUpdater &pu) { diff --git a/vcg/complex/edgemesh/base.h b/vcg/complex/edgemesh/base.h index 8ff9913a..ff874dad 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.3 2004/09/20 09:30:03 cignoni +Better Doxygen docs + Revision 1.2 2004/05/10 14:41:45 ganovelli name of adhacency function updated @@ -47,10 +50,10 @@ namespace edge { /** \addtogroup edgemesh */ /*@{*/ -/** Class Mesh. +/** \class EdgeMesh. This is class for definition of a mesh. - @param VertContainer (Template Parameter) Specifies the type of the vertices container any the vertex type. - @param STL_FACE_CONT (Template Parameter) Specifies the type of the faces container any the face type. + @param VertContainerType (Template Parameter) Specifies the type of the vertices container any the vertex type. + @param EdgeContainerType (Template Parameter) Specifies the type of the faces container any the face type. */ template < class VertContainerType, class EdgeContainerType > class EdgeMesh{ @@ -176,19 +179,15 @@ void InitVertexIMark() int imark; /** Check if the vertex incremental mark matches the one of the mesh. - @param v Vertex pointer */ inline bool IsMarked( ConstVertexPointer v ) const { return v->IMark() == imark; } /** Check if the face incremental mark matches the one of the mesh. - @param v Face pointer */ inline bool IsMarked( ConstEdgePointer f ) const { return f->IMark() == imark; } /** Set the vertex incremental mark of the vertex to the one of the mesh. - @param v Vertex pointer */ inline void Mark( ConstVertexPointer v ) const { v->IMark() = imark; } /** Set the face incremental mark of the vertex to the one of the mesh. - @param v Vertex pointer */ inline void Mark( ConstEdgePointer f ) const { f->IMark() = imark; } /// Unmark the mesh diff --git a/vcg/complex/edgemesh/update/topology.h b/vcg/complex/edgemesh/update/topology.h index 730dd0d7..db2cabce 100644 --- a/vcg/complex/edgemesh/update/topology.h +++ b/vcg/complex/edgemesh/update/topology.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.2 2004/05/10 14:42:17 ganovelli +nimor changes + ****************************************************************************/ #ifndef __VCG_EDGE_UPDATE_TOPOLOGY @@ -31,7 +34,7 @@ $Log: not supported by cvs2svn $ #include namespace vcg { namespace edge { -/** \addtogroup trimesh */ +/** \addtogroup edgemesh */ /*@{*/ template diff --git a/vcg/complex/tetramesh/update/normal.h b/vcg/complex/tetramesh/update/normal.h index 58fbe712..6d32862a 100644 --- a/vcg/complex/tetramesh/update/normal.h +++ b/vcg/complex/tetramesh/update/normal.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.7 2004/09/01 12:17:25 pietroni +minor changes to comply gcc compiler (typename's ) + Revision 1.6 2004/06/25 11:25:07 pietroni changrd update for a vertex normal functions void PerVertex(VertexType *v) @@ -60,7 +63,7 @@ Written some documentation and added to the trimes doxygen module namespace vcg { namespace tetra { -/** \addtogroup trimesh */ +/** \addtogroup tetramesh */ /*@{*/ /// Management, updating and computation of per-vertex and per-face normals. diff --git a/vcg/complex/tetramesh/update/triconvert.h b/vcg/complex/tetramesh/update/triconvert.h index 19107b01..e71f3076 100644 --- a/vcg/complex/tetramesh/update/triconvert.h +++ b/vcg/complex/tetramesh/update/triconvert.h @@ -194,7 +194,6 @@ void ConvertCopy(TetraContainer &tetra,TriangleMeshType &trim) } };// End class -/*@}*/ } // End namespace } // End namespace diff --git a/vcg/complex/trimesh/base.h b/vcg/complex/trimesh/base.h index dd2c3a98..56cbf893 100644 --- a/vcg/complex/trimesh/base.h +++ b/vcg/complex/trimesh/base.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.11 2004/10/07 14:25:38 ganovelli +added camera and shot + Revision 1.10 2004/09/08 15:15:05 ganovelli changes for gcc @@ -73,11 +76,11 @@ namespace vcg { namespace tri { /** \addtogroup trimesh */ /*@{*/ - +/*@{*/ /** Class Mesh. This is class for definition of a mesh. - @param VertContainer (Template Parameter) Specifies the type of the vertices container any the vertex type. - @param STL_FACE_CONT (Template Parameter) Specifies the type of the faces container any the face type. + @param VertContainerType (Template Parameter) Specifies the type of the vertices container any the vertex type. + @param FaceContainerType (Template Parameter) Specifies the type of the faces container any the face type. */ template < class VertContainerType, class FaceContainerType > class TriMesh{ @@ -268,7 +271,7 @@ ScalarType Volume() }; // end class Mesh - +/*@}*/ /*@}*/ } // end namespace } // end namespace diff --git a/vcg/complex/trimesh/edge_collapse.h b/vcg/complex/trimesh/edge_collapse.h index 960063e0..6326d12a 100644 --- a/vcg/complex/trimesh/edge_collapse.h +++ b/vcg/complex/trimesh/edge_collapse.h @@ -32,13 +32,14 @@ #include #include +namespace vcg{ +namespace tri{ + /** \addtogroup trimesh */ /*@{*/ /** This a static utlity class for the edge collapse. It provides a common set of useful function for actually making an edge collapse over a trimesh. See also **/ -namespace vcg{ - namespace tri{ template class EdgeCollapse diff --git a/vcg/complex/trimesh/platonic.h b/vcg/complex/trimesh/platonic.h index d8d0e612..645c6537 100644 --- a/vcg/complex/trimesh/platonic.h +++ b/vcg/complex/trimesh/platonic.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.9 2004/09/24 10:14:38 fiorin +Corrected bug in cone + Revision 1.8 2004/09/22 15:12:38 fiorin Corrected bug in hexahedron @@ -49,7 +52,8 @@ First working version (tetrahedron!) #include namespace vcg { namespace tri { -/*@{*/ +/** \addtogroup trimesh */ +//@{ /** A set of functions that builds meshes that represent surfaces of platonic solids, @@ -569,6 +573,7 @@ void Build( M & in, const V & v, const F & f) in.face.push_back(ft); } } +//@} } // End Namespace TriMesh } // End Namespace vcg diff --git a/vcg/simplex/face/base.h b/vcg/simplex/face/base.h index c3844508..55a666d9 100644 --- a/vcg/simplex/face/base.h +++ b/vcg/simplex/face/base.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.23 2004/10/25 08:22:40 ganovelli +IsBOrder (typecast on return type) + Revision 1.22 2004/10/20 08:28:31 fiorin Added constant access function FFp and renamed F1 F2 to FFp1 FFp2 @@ -108,12 +111,14 @@ class DUMMYEDGETYPE; class DUMMYFACETYPE; class DUMMYTETRATYPE; -/** -\ingroup face - @name Face - Class Face. - This is the base class for definition of a face of the mesh. - @param FVTYPE (Templete Parameter) Specifies the vertex class type. +/** \addtogroup face */ +//@{ +/*! + * This class represent the generic configurable Face; + * Usually you never direclty use this class with this name but you build + * your own type by directly including one of the .h files under the face/with + * directory. Each file specify a class type with the desired fields. So for example + * including 'vcg/simplex/face/with/FCFN.h' allow you to use the class FaceFCFN that has per-face color and normal stored inside. */ template > class FACE_TYPE { @@ -144,8 +149,7 @@ public: /***********************************************/ /** @name Vertex Pointer - blah - blah +Functions to access to the vertexes of the face; **/ //@{ protected: @@ -1234,7 +1238,7 @@ void Swap ( const int z ) }; //end Class - +//@} } // end namespace diff --git a/vcg/simplex/face/pos.h b/vcg/simplex/face/pos.h index 2ba59a99..a47bd152 100644 --- a/vcg/simplex/face/pos.h +++ b/vcg/simplex/face/pos.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.13 2004/10/18 17:14:42 ganovelli +error FFP -> FFp + Revision 1.12 2004/09/14 19:46:10 ganovelli constructor added @@ -64,7 +67,7 @@ Initial commit ****************************************************************************/ -/** \file pos.h +/** \file face/pos.h * Definition of vcg:face::Pos class. * This file contain the definition of vcg::face::Pos class and the derived vcg::face::PosN class. */ diff --git a/vcg/simplex/tetrahedron/pos.h b/vcg/simplex/tetrahedron/pos.h index c0872226..f732267b 100644 --- a/vcg/simplex/tetrahedron/pos.h +++ b/vcg/simplex/tetrahedron/pos.h @@ -97,8 +97,6 @@ void operator++() }; -/** \addtogroup tetra */ -/*@{*/ /** Templated over the class tetrahedron, it stores a \em position over a tetrahedron in a mesh. It contain a pointer to the current tetrahedron, @@ -465,7 +463,7 @@ PosLoop(TetraType* tp,const int fap,const int ep, } }; - +//@} }//end namespace tetra }//end namespace vcg diff --git a/vcg/simplex/vertex/base.h b/vcg/simplex/vertex/base.h index aa34eda1..08f11ec7 100644 --- a/vcg/simplex/vertex/base.h +++ b/vcg/simplex/vertex/base.h @@ -23,6 +23,9 @@ /**************************************************************************** History $Log: not supported by cvs2svn $ +Revision 1.20 2004/10/11 17:45:05 ganovelli +added template on corrdinate type (default Point3) + Revision 1.19 2004/09/28 15:24:56 fiorin DUMMY classes definition moved into vcg namespace @@ -51,6 +54,9 @@ Revision 1.12 2004/05/10 13:31:13 ganovelli function for edge adjacency added $Log: not supported by cvs2svn $ +Revision 1.20 2004/10/11 17:45:05 ganovelli +added template on corrdinate type (default Point3) + Revision 1.19 2004/09/28 15:24:56 fiorin DUMMY classes definition moved into vcg namespace @@ -129,13 +135,14 @@ namespace vcg { class DUMMYFACETYPE; class DUMMYEDGETYPE; class DUMMYTETRATYPE; -/** - \ingroup vertex - @name Vertex - Class Vertex. - This is the base class for definition of a vertex of the mesh. - @param FLTYPE (Template Parameter) Specifies the scalar field of the vertex coordinate type. - @param VFTYPE (Template Parameter) Specifies the type for the face, needed only for VF adjacency. +/** \addtogroup vertex */ +//@{ +/*! + * This class represent the generic configurable Vertex; + * Usually you never direclty use this class with this name but you build + * your own type by directly including one of the .h files under the face/with + * directory. Each file specify a class type with the desired fields. So for example + * including 'vcg/simplex/vertex/with/VCVN.h' allow you to use the class VertVCVN that has per-vertex color and normal stored inside. */ template , class CoordTYPE= Point3 > class VERTEX_TYPE { @@ -873,7 +880,7 @@ template typename VERTEX_TYPE::CoordType NormalizedNormalV(V return ((typename VERTEX_TYPE::CoordType) N/(typename VERTEX_TYPE::CoordType::ScalarType)i); } } - +//@} } // end namespace #endif diff --git a/wrap/io_trimesh/export_ply.h b/wrap/io_trimesh/export_ply.h index 46fbc519..02ca55f9 100644 --- a/wrap/io_trimesh/export_ply.h +++ b/wrap/io_trimesh/export_ply.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.9 2004/10/27 09:33:10 ganovelli +cast from scalar type to float added + Revision 1.8 2004/10/07 14:19:06 ganovelli shot/camera io added @@ -603,5 +606,5 @@ std::vector FlagV; } // end namespace tri } // end namespace io } // end namespace vcg - +//@} #endif diff --git a/wrap/io_trimesh/export_stl.h b/wrap/io_trimesh/export_stl.h index 93ea917c..98346fa0 100644 --- a/wrap/io_trimesh/export_stl.h +++ b/wrap/io_trimesh/export_stl.h @@ -25,6 +25,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.3 2004/03/09 21:26:47 cignoni +cr lf mismatch + Revision 1.2 2004/03/03 15:35:53 cignoni Yet another cr lf mismatch @@ -120,6 +123,5 @@ static bool Save(SaveMeshType &m, const char * filename , bool binary =true, con } // end Namespace vcg -//@} #endif \ No newline at end of file diff --git a/wrap/io_trimesh/import_stl.h b/wrap/io_trimesh/import_stl.h index 4f44428d..9e8ddadf 100644 --- a/wrap/io_trimesh/import_stl.h +++ b/wrap/io_trimesh/import_stl.h @@ -25,6 +25,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.7 2004/08/25 15:27:51 ponchio +Comma at end of enum. + Revision 1.6 2004/08/25 15:15:27 ganovelli minor changes to comply gcc compiler (typename's and stuff) @@ -214,7 +217,4 @@ static int OpenBinary( OpenMeshType &m, const char * filename, CallBackPos *cb=0 } // end Namespace io } // end Namespace vcg - -//@} - #endif diff --git a/wrap/io_trimesh/io_mask.h b/wrap/io_trimesh/io_mask.h index 2a318244..0f27cc74 100644 --- a/wrap/io_trimesh/io_mask.h +++ b/wrap/io_trimesh/io_mask.h @@ -24,6 +24,9 @@ History $Log: not supported by cvs2svn $ +Revision 1.3 2004/05/12 10:19:30 ganovelli +new line added at the end of file + Revision 1.2 2004/03/09 21:26:47 cignoni cr lf mismatch @@ -34,10 +37,6 @@ Initial commit #ifndef __VCGLIB_IOTRIMESH_IO_MASK #define __VCGLIB_IOTRIMESH_IO_MASK -/** -@name Load and Save in Ply format -*/ -//@{ #include #include @@ -45,6 +44,10 @@ namespace vcg { namespace tri { namespace io { +/** +@name Load and Save in Ply format +*/ +//@{ class PLYMask { @@ -108,6 +111,7 @@ static void SMFlags2String( int mask, char str[] ) } }; // end class +//@} } // end namespace tri } // end namespace io } // end namespace vcg