From 2d185917826a2aab54f8fb68ea7a3fb564e50c7a Mon Sep 17 00:00:00 2001
From: cignoni <paolo.cignoni@isti.cnr.it>
Date: Wed, 13 Oct 2004 12:45:51 +0000
Subject: [PATCH] Better Doxygen documentation

---
 docs/Doxygen/doxyfile     | 4 ++--
 docs/Doxygen/groups.dxy   | 4 ++--
 vcg/space/intersection2.h | 6 +++---
 vcg/space/intersection3.h | 8 ++++++--
 vcg/space/point3.h        | 6 ++++++
 vcg/space/tetra3.h        | 7 ++++---
 6 files changed, 23 insertions(+), 12 deletions(-)

diff --git a/docs/Doxygen/doxyfile b/docs/Doxygen/doxyfile
index ad351631..a45d7bcc 100644
--- a/docs/Doxygen/doxyfile
+++ b/docs/Doxygen/doxyfile
@@ -5,8 +5,8 @@
 #---------------------------------------------------------------------------
 PROJECT_NAME           = "VCG Library"
 PROJECT_NUMBER         = 
-OUTPUT_DIRECTORY       = C:/Documenti/sf/docs/Doxygen/
-CREATE_SUBDIRS         = NO
+OUTPUT_DIRECTORY       = .
+CREATE_SUBDIRS         = YES
 OUTPUT_LANGUAGE        = English
 USE_WINDOWS_ENCODING   = YES
 BRIEF_MEMBER_DESC      = YES
diff --git a/docs/Doxygen/groups.dxy b/docs/Doxygen/groups.dxy
index 84b6e39f..5235cb65 100644
--- a/docs/Doxygen/groups.dxy
+++ b/docs/Doxygen/groups.dxy
@@ -1,6 +1,6 @@
 /** \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 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.
 */
 /** \defgroup face Faces 
Face of a triangular or a tetrahedral mesh
diff --git a/vcg/space/intersection2.h b/vcg/space/intersection2.h
index 0f695b66..9a6a3a41 100644
--- a/vcg/space/intersection2.h
+++ b/vcg/space/intersection2.h
@@ -34,6 +34,8 @@
 #include <vcg/space/triangle2.h>
 
 
+
+namespace vcg {
 /** \addtogroup space */
 /*@{*/
 /** 
@@ -41,8 +43,6 @@
     2 dimension
 */
 
-namespace vcg {
-
 /// return true if the algle is convex (right rotation)
 template<class SCALAR_TYPE>
     inline bool Convex(const Point2<SCALAR_TYPE> & p0,const Point2<SCALAR_TYPE> & p1,const Point2<SCALAR_TYPE> & p2)
@@ -62,6 +62,6 @@ template<class SCALAR_TYPE>
   return((Convex(p,p0,p1))&&(Convex(p,p1,p2))&&(Convex(p,p2,p0)));
   //return((Convex(p,p0,p1))&&(Convex(p,p1,p2))&&(Convex(p,p2,p0)));
 }
-
+/*@}*/
 } // end namespace
 #endif
diff --git a/vcg/space/intersection3.h b/vcg/space/intersection3.h
index 81df14c3..7765ead2 100644
--- a/vcg/space/intersection3.h
+++ b/vcg/space/intersection3.h
@@ -24,6 +24,9 @@
   History
 
 $Log: not supported by cvs2svn $
+Revision 1.11  2004/09/09 14:41:32  ponchio
+forgotten typename SEGMENTTYPE::...
+
 Revision 1.10  2004/08/09 09:48:43  pietroni
 correcter .dir to .Direction and .ori in .Origin()
 
@@ -75,14 +78,14 @@ Initial Commit
 
 
 
+
+namespace vcg {
 /** \addtogroup space */
 /*@{*/
 /** 
     Function computing the intersection between couple of geometric primitives in
     3 dimension
 */
-
-namespace vcg {
   /// interseciton between sphere and line
   template<class T>
     inline bool Intersection( const Sphere3<T> & sp, const Line3<T> & li, Point3<T> & p0,Point3<T> & p1 ){
@@ -297,6 +300,7 @@ bool Intersection( const Line3<T> & ray, const Point3<T> & vert0,
 	inte = vert0 + edge1*a + edge2*b;
   return true;
 }
+/*@}*/
 
 } // end namespace
 #endif
diff --git a/vcg/space/point3.h b/vcg/space/point3.h
index 0bb04f05..ed360b3e 100644
--- a/vcg/space/point3.h
+++ b/vcg/space/point3.h
@@ -24,6 +24,9 @@
   History
 
 $Log: not supported by cvs2svn $
+Revision 1.17  2004/09/10 14:01:40  cignoni
+Added polar to cartesian
+
 Revision 1.16  2004/03/21 17:14:56  ponchio
 Added a math::
 
@@ -68,6 +71,7 @@ Edited doxygen comments
 #include <vcg/math/base.h>
 
 namespace vcg {
+
 /** \addtogroup space */
 /*@{*/
     /**
@@ -458,6 +462,8 @@ typedef Point3<float>  Point3f;
 typedef Point3<double> Point3d;
 
 /*@}*/
+
 } // end namespace
+
 #endif
 
diff --git a/vcg/space/tetra3.h b/vcg/space/tetra3.h
index c9e3c3c1..175ee41d 100644
--- a/vcg/space/tetra3.h
+++ b/vcg/space/tetra3.h
@@ -24,6 +24,9 @@
   History
 
 $Log: not supported by cvs2svn $
+Revision 1.8  2004/09/01 12:21:11  pietroni
+minor changes to comply gcc compiler (typename's )
+
 Revision 1.7  2004/07/09 10:08:21  ganovelli
 ComputeVOlume moved outside the class and other
  minor corrections
@@ -272,8 +275,6 @@ static int FofEE(const int &indexE0,const int &indexE1)
 }
 };
 
-/** \addtogroup space */
-/*@{*/
 /** 
 		Templated class for storing a generic tetrahedron in a 3D space.
     Note the relation with the Face class of TetraMesh complex, both classes provide the P(i) access functions to their points and therefore they share the algorithms on it (e.g. area, normal etc...)
@@ -373,7 +374,7 @@ Point3<typename TetraType::ScalarType> Normal( const TetraType &t,const int &fac
 {
   return(((t.cP(Tetra::VofF(face,1))-t.cP(Tetra::VofF(face,0)))^(t.cP(Tetra::VofF(face,2))-t.cP(Tetra::VofF(face,0)))).Normalize());
 }
-
+/*@}*/
 }	 // end namespace