Commit 1de2fe2c98c99f5dc9071f9d23b5e3c7c012b698
2002-12-21T07:19:50
Fixed docs
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
diff --git a/include/FTGlyphContainer.h b/include/FTGlyphContainer.h
index a9388e6..e0ae26d 100755
--- a/include/FTGlyphContainer.h
+++ b/include/FTGlyphContainer.h
@@ -36,41 +36,42 @@ class FTGL_EXPORT FTGlyphContainer
/**
* Adds a glyph to this glyph list.
*
- * @param glyph The FTGlyph to be inserted into the container
- * @param g The glyphs index in the container.
- * @return <code>true</code>
+ * @param glyph The FTGlyph to be inserted into the container
+ * @param glyphIndex The glyphs index in the container.
+ * @return <code>true</code>
*/
bool Add( FTGlyph* glyph, unsigned int glyphIndex);
/**
* Get a glyph from the glyph list
*
- * @param c The char code of the glyph NOT the glyph index
- * @return An FTGlyph or <code>null</code> is it hasn't been
+ * @param characterCode The char code of the glyph NOT the glyph index
+ * @return An FTGlyph or <code>null</code> is it hasn't been
* loaded.
*/
const FTGlyph* const Glyph( const unsigned int characterCode) const;
/**
* Get the bounding box for a character.
+ * @param characterCode The char code of the glyph NOT the glyph index
*/
FTBBox BBox( const unsigned int characterCode) const;
/**
* 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 characterCode glyph index of the character
+ * @param nextCharacterCode the next glyph in a string
+ * @return advance width
*/
float Advance( unsigned int characterCode, unsigned int nextCharacterCode);
/**
* Renders a character
- * @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
+ * @param characterCode the glyph to be Rendered
+ * @param nextCharacterCode the next glyph in the string. Used for kerning.
+ * @param penPosition the position to Render the glyph
+ * @return The distance to advance the pen position after Rendering
*/
FTPoint Render( unsigned int characterCode, unsigned int nextCharacterCode, FTPoint penPosition);