Updated comments
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
diff --git a/include/FTGlyph.h b/include/FTGlyph.h
index a60428f..d852870 100755
--- a/include/FTGlyph.h
+++ b/include/FTGlyph.h
@@ -25,7 +25,7 @@ class FTGlyph
/**
* Constructor
*
- * @param glyphIndex The glyph index
+ * @param glyphIndex The glyph index for this glyph
*/
FTGlyph( unsigned int glyphIndex);
@@ -35,7 +35,10 @@ class FTGlyph
virtual ~FTGlyph();
/**
+ * Renders this glyph at the current pen position.
*
+ * @param v The current pen position.
+ * @return The advance distance for this glyph.
*/
virtual float Render( const FT_Vector& v) = 0;
@@ -49,7 +52,7 @@ class FTGlyph
// attributes
/**
- *
+ * The glyph index
*/
const unsigned int glyphIndex; // FIXME make this private
diff --git a/include/FTLibrary.h b/include/FTLibrary.h
index 2c99218..ce922b9 100755
--- a/include/FTLibrary.h
+++ b/include/FTLibrary.h
@@ -79,8 +79,9 @@ class FTLibrary
* Even though this function indicates success via the return value,
* clients can't see this so must check the error codes.
*
- * @return <code>true</code> if the Freetype library was successfully
- * initialised, <code>false</code> otherwise.
+ * @return <code>true</code> if the Freetype library was
+ * successfully initialised, <code>false</code>
+ * otherwise.
*/
bool Init();