Documentation Changes
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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
diff --git a/include/FTBBox.h b/include/FTBBox.h
index c8918ea..ea5da4e 100755
--- a/include/FTBBox.h
+++ b/include/FTBBox.h
@@ -9,13 +9,14 @@
/**
- * FTBBox
- *
- *
+ * FTBBox is a convenience class for handling bounding boxes.
*/
class FTGL_EXPORT FTBBox
{
public:
+ /**
+ * Default constructor. Bounding box is set to zero.
+ */
FTBBox()
: lowerX(0),
lowerY(0),
@@ -25,6 +26,12 @@ class FTGL_EXPORT FTBBox
upperZ(0)
{}
+ /**
+ * Constructor. Extracts a bounding box from a freetype glyph. Uses
+ * the control box for the glyph. <code>FT_Glyph_Get_CBox()</code>
+ *
+ * @param glyph A freetype glyph
+ */
FTBBox( FT_Glyph glyph)
{
FT_BBox bbox;
@@ -37,19 +44,16 @@ class FTGL_EXPORT FTBBox
upperY = bbox.yMax >> 6;
upperZ = 0;
}
-
- FTBBox( int a, int b, int c, int d, int e, int f)
- : lowerX(a),
- lowerY(b),
- lowerZ(c),
- upperX(d),
- upperY(e),
- upperZ(f)
- {}
+ /**
+ * Destructor
+ */
~FTBBox()
{}
+ /**
+ * The bounds of the box
+ */
// Make these ftPoints & private
float lowerX, lowerY, lowerZ, upperX, upperY, upperZ;
protected:
diff --git a/include/FTCharmap.h b/include/FTCharmap.h
index fdc3ed8..adbc327 100644
--- a/include/FTCharmap.h
+++ b/include/FTCharmap.h
@@ -21,6 +21,8 @@
* freetype calls and will save significant amounts of memory when dealing
* with uncode encoding
*
+ * @see "Freetype 2 Documentation"
+ *
*/
class FTGL_EXPORT FTCharmap
{
diff --git a/include/FTFace.h b/include/FTFace.h
index c5f330f..7bc2d0d 100755
--- a/include/FTFace.h
+++ b/include/FTFace.h
@@ -15,7 +15,7 @@ class FTCharmap;
/**
* FTFace class provides an abstraction layer for the Freetype Face.
*
- * @see "Freetype 2 Documentation - 2.0.4"
+ * @see "Freetype 2 Documentation"
*
*/
class FTGL_EXPORT FTFace
diff --git a/include/FTFont.h b/include/FTFont.h
index 285d71f..a8cafe6 100755
--- a/include/FTFont.h
+++ b/include/FTFont.h
@@ -269,8 +269,6 @@ class FTGL_EXPORT FTFont
* @param nextChr next character
*/
inline void doRender( const unsigned int chr, const unsigned int nextChr);
-
-
};
diff --git a/include/FTGLExtrdFont.h b/include/FTGLExtrdFont.h
index 87ee5c0..12bcdb3 100644
--- a/include/FTGLExtrdFont.h
+++ b/include/FTGLExtrdFont.h
@@ -9,10 +9,11 @@ class FTGlyph;
/**
- * FTGLPolygonFont is a specialisation of the FTFont class for handling
- * tesselated Polygon Mesh fonts
+ * FTGLExtrdFont is a specialisation of the FTFont class for handling
+ * extruded Polygon fonts
*
* @see FTFont
+ * @see FTGLPolygonFont
*/
class FTGL_EXPORT FTGLExtrdFont : public FTFont
{
@@ -34,7 +35,7 @@ class FTGL_EXPORT FTGLExtrdFont : public FTFont
* Construct a FTPolyGlyph.
*
* @param g The glyph index NOT the char code.
- * @return An FTPolyGlyph or <code>null</code> on failure.
+ * @return An FTExtrdGlyph or <code>null</code> on failure.
*/
inline virtual FTGlyph* MakeGlyph( unsigned int g);
diff --git a/include/FTLibrary.h b/include/FTLibrary.h
index e895ba3..0208e82 100755
--- a/include/FTLibrary.h
+++ b/include/FTLibrary.h
@@ -23,7 +23,7 @@
* for errors using the following code...
* <code>err = FTLibrary::Instance().Error();</code>
*
- * @see "Freetype 2 Documentation - 2.0.4"
+ * @see "Freetype 2 Documentation"
*
*/
class FTGL_EXPORT FTLibrary
diff --git a/include/FTPoint.h b/include/FTPoint.h
index 1b70a48..b7affc0 100755
--- a/include/FTPoint.h
+++ b/include/FTPoint.h
@@ -9,10 +9,6 @@
/**
* FTPoint class is a basic 3 dimensional point or vector.
- *
- * @see FTOutlineGlyph
- * @see FTPolyGlyph
- *
*/
class FTGL_EXPORT FTPoint
{
@@ -36,11 +32,9 @@ class FTGL_EXPORT FTPoint
{}
/**
- * Constructor.
+ * Constructor. This converts an FT_Vector to an FT_Point
*
- * @param X
- * @param Y
- * @param Z
+ * @param ft_vector A freetype vector
*/
FTPoint( const FT_Vector& ft_vector)
: x(ft_vector.x), y(ft_vector.y), z(0)
diff --git a/src/FTGLBitmapFont.cpp b/src/FTGLBitmapFont.cpp
index 018bd0e..5ed6f62 100755
--- a/src/FTGLBitmapFont.cpp
+++ b/src/FTGLBitmapFont.cpp
@@ -1,5 +1,5 @@
-#include "FTGLBitmapFont.h"
-#include "FTBitmapGlyph.h"
+#include "FTGLBitmapFont.h"
+#include "FTBitmapGlyph.h"
FTGLBitmapFont::FTGLBitmapFont()