Commit 66f17834d4e973eb16981041289ca0cba5c3883a
2002-12-16T08:53:10
Updated the 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 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
diff --git a/include/FTFont.h b/include/FTFont.h
index 9164430..c6b9df4 100755
--- a/include/FTFont.h
+++ b/include/FTFont.h
@@ -29,21 +29,17 @@ class FTGL_EXPORT FTFont
{
public:
/**
- * Open and read a font file.
+ * Open and read a font file. Sets Error flag.
*
* @param fontname font file name.
- * @return <code>true</code> if file has opened
- * successfully.
*/
FTFont( const char* fontname);
/**
- * Open and read a font from a buffer in memory.
+ * Open and read a font from a buffer in memory. Sets Error flag.
*
* @param pBufferBytes the in-memory buffer
* @param bufferSizeInBytes the length of the buffer in bytes
- * @return <code>true</code> if the data stream has
- * opened successfully.
*/
FTFont( const unsigned char *pBufferBytes, size_t bufferSizeInBytes);
diff --git a/include/FTGLBitmapFont.h b/include/FTGLBitmapFont.h
index c5baeea..114ed3e 100755
--- a/include/FTGLBitmapFont.h
+++ b/include/FTGLBitmapFont.h
@@ -17,10 +17,18 @@ class FTGL_EXPORT FTGLBitmapFont : public FTFont
{
public:
/**
- * Constructor
+ * Open and read a font file. Sets Error flag.
+ *
+ * @param fontname font file name.
*/
FTGLBitmapFont( const char* fontname);
+ /**
+ * Open and read a font from a buffer in memory. Sets Error flag.
+ *
+ * @param pBufferBytes the in-memory buffer
+ * @param bufferSizeInBytes the length of the buffer in bytes
+ */
FTGLBitmapFont( const unsigned char *pBufferBytes, size_t bufferSizeInBytes);
/**
diff --git a/include/FTGLExtrdFont.h b/include/FTGLExtrdFont.h
index c23c2de..3c96984 100644
--- a/include/FTGLExtrdFont.h
+++ b/include/FTGLExtrdFont.h
@@ -18,11 +18,19 @@ class FTGlyph;
class FTGL_EXPORT FTGLExtrdFont : public FTFont
{
public:
- /**
- * Default Constructor
- */
+ /**
+ * Open and read a font file. Sets Error flag.
+ *
+ * @param fontname font file name.
+ */
FTGLExtrdFont( const char* fontname);
+ /**
+ * Open and read a font from a buffer in memory. Sets Error flag.
+ *
+ * @param pBufferBytes the in-memory buffer
+ * @param bufferSizeInBytes the length of the buffer in bytes
+ */
FTGLExtrdFont( const unsigned char *pBufferBytes, size_t bufferSizeInBytes);
/**
diff --git a/include/FTGLOutlineFont.h b/include/FTGLOutlineFont.h
index 09ffc66..22e694a 100755
--- a/include/FTGLOutlineFont.h
+++ b/include/FTGLOutlineFont.h
@@ -18,10 +18,18 @@ class FTGL_EXPORT FTGLOutlineFont : public FTFont
{
public:
/**
- * Default Constructor
+ * Open and read a font file. Sets Error flag.
+ *
+ * @param fontname font file name.
*/
FTGLOutlineFont( const char* fontname);
+ /**
+ * Open and read a font from a buffer in memory. Sets Error flag.
+ *
+ * @param pBufferBytes the in-memory buffer
+ * @param bufferSizeInBytes the length of the buffer in bytes
+ */
FTGLOutlineFont( const unsigned char *pBufferBytes, size_t bufferSizeInBytes);
/**
diff --git a/include/FTGLPixmapFont.h b/include/FTGLPixmapFont.h
index f98ec48..f4c9189 100755
--- a/include/FTGLPixmapFont.h
+++ b/include/FTGLPixmapFont.h
@@ -19,10 +19,18 @@ class FTGL_EXPORT FTGLPixmapFont : public FTFont
{
public:
/**
- * Default Constructor
+ * Open and read a font file. Sets Error flag.
+ *
+ * @param fontname font file name.
*/
FTGLPixmapFont( const char* fontname);
+ /**
+ * Open and read a font from a buffer in memory. Sets Error flag.
+ *
+ * @param pBufferBytes the in-memory buffer
+ * @param bufferSizeInBytes the length of the buffer in bytes
+ */
FTGLPixmapFont( const unsigned char *pBufferBytes, size_t bufferSizeInBytes);
/**
diff --git a/include/FTGLPolygonFont.h b/include/FTGLPolygonFont.h
index 8e33f66..1e41721 100755
--- a/include/FTGLPolygonFont.h
+++ b/include/FTGLPolygonFont.h
@@ -18,10 +18,18 @@ class FTGL_EXPORT FTGLPolygonFont : public FTFont
{
public:
/**
- * Default Constructor
+ * Open and read a font file. Sets Error flag.
+ *
+ * @param fontname font file name.
*/
FTGLPolygonFont( const char* fontname);
+ /**
+ * Open and read a font from a buffer in memory. Sets Error flag.
+ *
+ * @param pBufferBytes the in-memory buffer
+ * @param bufferSizeInBytes the length of the buffer in bytes
+ */
FTGLPolygonFont( const unsigned char *pBufferBytes, size_t bufferSizeInBytes);
/**
diff --git a/include/FTGLTextureFont.h b/include/FTGLTextureFont.h
index f877197..9a2a5ff 100755
--- a/include/FTGLTextureFont.h
+++ b/include/FTGLTextureFont.h
@@ -17,10 +17,18 @@ class FTGL_EXPORT FTGLTextureFont : public FTFont
{
public:
/**
- * Constructor
+ * Open and read a font file. Sets Error flag.
+ *
+ * @param fontname font file name.
*/
FTGLTextureFont( const char* fontname);
+ /**
+ * Open and read a font from a buffer in memory. Sets Error flag.
+ *
+ * @param pBufferBytes the in-memory buffer
+ * @param bufferSizeInBytes the length of the buffer in bytes
+ */
FTGLTextureFont( const unsigned char *pBufferBytes, size_t bufferSizeInBytes);
/**