From 48a4d61651b5c46e0259f353b0a9c8f255ef24c8 Mon Sep 17 00:00:00 2001
From: "donal.k.fellows@manchester.ac.uk" <dkf>
Date: Mon, 4 Feb 2008 09:53:21 +0000
Subject: Minor documentation improvements

---
 ChangeLog         |  5 +++++
 doc/FontId.3      | 21 ++++++++++-----------
 doc/MeasureChar.3 | 10 ++++------
 3 files changed, 19 insertions(+), 17 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 13ef33d..d17c612 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-02-04  Donal K. Fellows  <donal.k.fellows@man.ac.uk>
+
+	* doc/MeasureChar.3, doc/FontId.3: Minor improvements (formatting,
+	keywords).
+
 2007-02-02  Daniel Steffen  <das@users.sourceforge.net>
 
 	*** 8.5.1 TAGGED FOR RELEASE ***
diff --git a/doc/FontId.3 b/doc/FontId.3
index 8a95b87..c052a7c 100644
--- a/doc/FontId.3
+++ b/doc/FontId.3
@@ -4,7 +4,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: FontId.3,v 1.10 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: FontId.3,v 1.11 2008/02/04 09:53:23 dkf Exp $
 '\" 
 .so man.macros
 .TH Tk_FontId 3 8.0 Tk "Tk Library Procedures"
@@ -19,12 +19,10 @@ fonts
 Font
 \fBTk_FontId(\fItkfont\fB)\fR
 .sp
-void
 \fBTk_GetFontMetrics(\fItkfont, fmPtr\fB)\fR
 .sp
 int
 \fBTk_PostscriptFontName(\fItkfont, dsPtr\fB)\fR
-
 .SH ARGUMENTS
 .AS Tk_FontMetrics *dsPtr
 .AP Tk_Font tkfont in
@@ -32,12 +30,11 @@ Opaque font token being queried.  Must have been returned by a previous
 call to \fBTk_GetFont\fR.
 .AP Tk_FontMetrics *fmPtr out
 Pointer to structure in which the font metrics for \fItkfont\fR will
-be stored.
+be stored. See \fBDATA STRUCTURES\fR below for details.
 .AP Tcl_DString *dsPtr out
 Pointer to an initialized \fBTcl_DString\fR to which the name of the
 Postscript font that corresponds to \fItkfont\fR will be appended.
 .BE
-
 .SH DESCRIPTION
 .PP
 Given a \fItkfont\fR, \fBTk_FontId\fR returns the token that should be
@@ -70,13 +67,13 @@ following screen font families should print correctly:
 Any other font families may not print correctly because the computed
 Postscript font name may be incorrect or not exist on the printer.
 .SH "DATA STRUCTURES"
-The Tk_FontMetrics data structure is used by Tk_GetFontMetrics to return 
-information about a font and is defined as follows:
+The \fBTk_FontMetrics\fR data structure is used by \fBTk_GetFontMetrics\fR to
+return information about a font and is defined as follows:
 .CS
 typedef struct Tk_FontMetrics {
-    int ascent;
-    int descent;
-    int linespace;
+    int \fIascent\fR;
+    int \fIdescent\fR;
+    int \fIlinespace\fR;
 } Tk_FontMetrics;
 .CE
 .PP
@@ -92,5 +89,7 @@ The \fIlinespace\fR is the sum of the ascent and descent.  How far
 apart two lines of text in the same font should be placed so that none
 of the characters in one line overlap any of the characters in the
 other line.
+.SH "SEE ALSO"
+font(n), MeasureChar(3)
 .SH KEYWORDS
-font
+font, measurement, Postscript
diff --git a/doc/MeasureChar.3 b/doc/MeasureChar.3
index ff165f4..5a9b5ed 100644
--- a/doc/MeasureChar.3
+++ b/doc/MeasureChar.3
@@ -4,7 +4,7 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: MeasureChar.3,v 1.9 2007/12/13 15:23:43 dgp Exp $
+'\" RCS: @(#) $Id: MeasureChar.3,v 1.10 2008/02/04 09:53:24 dkf Exp $
 '\" 
 .so man.macros
 .TH Tk_MeasureChars 3 8.1 Tk "Tk Library Procedures"
@@ -21,10 +21,8 @@ int
 int
 \fBTk_TextWidth(\fItkfont, string, numBytes\fB)\fR
 .sp
-void
 \fBTk_DrawChars(\fIdisplay, drawable, gc, tkfont, string, numBytes, x, y\fB)\fR
 .sp
-void
 \fBTk_UnderlineChars(\fIdisplay, drawable, gc, tkfont, string, x, y, firstByte, lastByte\fB)\fR
 .sp
 .SH ARGUMENTS
@@ -77,7 +75,6 @@ The index of the first byte of the last character up to which the
 underline will be drawn.  The character specified by \fIlastByte\fR
 will not itself be underlined.
 .BE
-
 .SH DESCRIPTION
 .PP
 These routines are for measuring and displaying simple single-font,
@@ -126,6 +123,7 @@ have been displayed previously by \fBTk_DrawChars\fR); it just draws the
 underline.  This procedure is used to underline a few characters without
 having to construct an underlined font.  To produce natively underlined
 text, the appropriate underlined font should be constructed and used. 
-
+.SH "SEE ALSO"
+font(n), FontId(3)
 .SH KEYWORDS
-font
+font, measurement
-- 
cgit v0.12