Fixing up the 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 50 51
diff --git a/include/FTGlyphContainer.h b/include/FTGlyphContainer.h
index b5e8a55..4cba495 100755
--- a/include/FTGlyphContainer.h
+++ b/include/FTGlyphContainer.h
@@ -49,9 +49,9 @@ class FTGL_EXPORT FTGlyphContainer
/**
* Returns the kerned advance width for a glyph.
*
- * param index glyph index of the character
- * param next the next glyph in a string
- * return advance width
+ * @param index glyph index of the character
+ * @param next the next glyph in a string
+ * @return advance width
*/
float Advance( unsigned int index, unsigned int next);
@@ -60,7 +60,7 @@ class FTGL_EXPORT FTGlyphContainer
* @param index the glyph to be rendered
* @param next the next glyph in the string. Used for kerning.
* @param pen the position to render the glyph
- * return The distance to advance the pen position after rendering
+ * @return The distance to advance the pen position after rendering
*/
FT_Vector& render( unsigned int index, unsigned int next, FT_Vector pen);
diff --git a/include/FTVectoriser.h b/include/FTVectoriser.h
index 76ac623..ef69076 100644
--- a/include/FTVectoriser.h
+++ b/include/FTVectoriser.h
@@ -76,7 +76,7 @@ class FTGL_EXPORT ftPoint
/**
- * ftPoint class is a container of points that describe an outline
+ * FTContour class is a container of points that describe an outline
* point data.
*
* @see FTOutlineGlyph
@@ -122,8 +122,9 @@ class FTGL_EXPORT FTContour
private:
/**
- * A 'max' number of points that this contour hods. Note it can
- * hold more than this number.
+ * A 'max' number of points that this contour holds. Note however it
+ * can hold more than this number. It is just used to reserve space
+ * in the <vector>
*/
const unsigned int kMAXPOINTS;
};