Commit f9bbdd7862e2f15bcd34923852dbef1719329d60
2002-11-28T08:23:56
Changes to Documentation
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
diff --git a/include/FTSize.h b/include/FTSize.h
index 5964779..d391759 100755
--- a/include/FTSize.h
+++ b/include/FTSize.h
@@ -12,7 +12,7 @@
/**
* FTSize class provides an abstraction layer for the Freetype Size.
*
- * @see "Freetype 2 Documentation - 2.0.4"
+ * @see "Freetype 2 Documentation"
*
*/
class FTGL_EXPORT FTSize
diff --git a/include/FTVector.h b/include/FTVector.h
index 9a60a48..97def2a 100644
--- a/include/FTVector.h
+++ b/include/FTVector.h
@@ -1,5 +1,11 @@
+#ifndef __FTVector__
+#define __FTVector__
+
#include "FTGL.h"
+/**
+ * Provides a non-STL alternative to the STL vector
+ */
template <typename FT_VECTOR_ITEM_TYPE>
class FTGL_EXPORT FTVector
{
@@ -188,3 +194,5 @@ class FTGL_EXPORT FTVector
size_type Size;
value_type* Items;
};
+
+#endif // __FTVector__
diff --git a/include/FTVectoriser.h b/include/FTVectoriser.h
index 5e7da55..be7f61d 100644
--- a/include/FTVectoriser.h
+++ b/include/FTVectoriser.h
@@ -21,7 +21,7 @@
*
* @see FTOutlineGlyph
* @see FTPolyGlyph
- * @see ftPoint
+ * @see FTPoint
*
*/
class FTGL_EXPORT FTContour
@@ -87,14 +87,23 @@ class FTGL_EXPORT FTContour
};
+/**
+ * FTTesselation captures points that are output by OpenGL's gluTesselator.
+ */
class FTGL_EXPORT FTTesselation
{
public:
+ /**
+ * Default constructor
+ */
FTTesselation()
{
pointList.reserve( 128);
}
+ /**
+ * Destructor
+ */
~FTTesselation()
{
pointList.clear();
@@ -118,20 +127,33 @@ class FTGL_EXPORT FTTesselation
};
+/**
+ * FTMesh is a container of FTTesselation s that make up a polygon glyph
+ */
class FTGL_EXPORT FTMesh
{
public:
+ /**
+ * Default constructor
+ */
FTMesh();
+
+ /**
+ * Destructor
+ */
~FTMesh();
void AddPoint( const FTGL_DOUBLE x, const FTGL_DOUBLE y, const FTGL_DOUBLE z);
void Begin( GLenum m);
void End();
+ void Error( GLenum e) { err = e;}
FTGL_DOUBLE* Point();
int size() const;
- void Error( GLenum e) { err = e;}
+ /**
+ * Get the GL ERROR returned by the glu tesselator
+ */
GLenum Error() const { return err;}
typedef FTVector<FTPoint> PointVector;
@@ -147,6 +169,10 @@ class FTGL_EXPORT FTMesh
* The list of points in this mesh
*/
FTTesselation* tempTess;
+
+ /**
+ * GL ERROR returned by the glu tesselator
+ */
GLenum err;
};
@@ -244,7 +270,7 @@ class FTGL_EXPORT FTVectoriser
private:
/**
- * Process a conic ( second order bezier curve)
+ * Process a conic ( second order) bezier curve.
*
* @param index The index of the current point in the point list.
* @param first The index into the pointlist of the first point in