diff options
author | wl <wl> | 2006-01-26 20:09:06 +0000 |
---|---|---|
committer | wl <wl> | 2006-01-26 20:09:06 +0000 |
commit | e525b2dffb8e73f9d8db7dd3ae77a6a0b4bccbff (patch) | |
tree | 9f618c685a2be1d77b03eef78546009065d49d16 | |
parent | 231e1962566acc692647ced91d90c445de8b903e (diff) | |
download | groff-e525b2dffb8e73f9d8db7dd3ae77a6a0b4bccbff.tar.gz |
Minor doc improvement. From Bruno.
-rw-r--r-- | src/include/font.h | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/src/include/font.h b/src/include/font.h index 49cc6ef6..82a7d939 100644 --- a/src/include/font.h +++ b/src/include/font.h @@ -61,17 +61,19 @@ public: int get_height(int, int); // A rectangle represents the shape of the // glyph with the given index (arg1) at the given // point size (arg2). Return the distance between - // the base line and the top of this rectangle. If - // the top is above the base line, this value is - // positive. + // the base line and the top of this rectangle. + // This is often also called the `ascent' of the + // glyph. If the top is above the base line, this + // value is positive. int get_depth(int, int); // A rectangle represents the shape of the // glyph with the given index (arg1) at the given // point size (arg2). Return the distance between // the base line and the bottom of this rectangle. - // If the bottom is below the base line, this value - // is positive. + // This is often also called the `descent' of the + // glyph. If the bottom is below the base line, + // this value is positive. int get_space_width(int); // Return the normal width of a space at the - // given point size. + // given point size. int get_character_type(int); // Return a bit mask describing the shape of // the glyph with the given index. Bit 0 is set if // the character has a descender. Bit 1 is set if |