From: Matt Birkholz <puck@birchwood-abbey.net>
Date: Sun, 5 Feb 2017 03:44:56 +0000 (-0700)
Subject: glib, gtk: Address documentation formatting warnings.
X-Git-Tag: mit-scheme-pucked-9.2.12~226
X-Git-Url: https://birchwood-abbey.net/git?a=commitdiff_plain;h=639d13040423e4da1bfff0208f1bebc00bf9141a;p=mit-scheme.git

glib, gtk: Address documentation formatting warnings.

Fix overfull boxes by adding line breaks or shortening words.  Fix
underfull boxes by putting @raggedright / @end around long lists of
long identifiers.  And punt a self-referential (undefined) xref.
---

diff --git a/src/glib/mit-scheme-pucked-glib.texi b/src/glib/mit-scheme-pucked-glib.texi
index f8b12558a..d45fbc1d6 100644
--- a/src/glib/mit-scheme-pucked-glib.texi
+++ b/src/glib/mit-scheme-pucked-glib.texi
@@ -150,10 +150,10 @@ as @var{alien-function}.  @var{alien-function} should be a callback
 trampoline, as in this example:
 
 @example
-  (g-signal-connect window (C-callback "delete_event") delete-callback)
+  (g-signal-connect window (C-callback "delete_event") callback)
 @end example
 
-Note that @var{delete-callback} should reference @var{window} via
+Note that @var{callback} should reference @var{window} via
 parameter @emph{only}.  @xref{pinned-objects}.
 @end deffn
 
@@ -291,6 +291,7 @@ attribute's value is a GFileType member, e.g. @code{(C-enum
 "G_FILE_TYPE_UNKNOWN")}.  For a complete list of GFileType members and
 other GIO constants, see your @file{gioenums.h} header file.
 
+@raggedright
 Here are the 76 keys listed in the @file{gfileinfo.h} header:
 @code{standard::type},
 @code{standard::is-hidden},
@@ -368,6 +369,7 @@ Here are the 76 keys listed in the @file{gfileinfo.h} header:
 @code{trash::item-count},
 @code{trash::orig-path}, or
 @code{trash::deletion-date}.
+@end raggedright
 
 @deffn Procedure gfile-info-list-attributes ginfo namespace
 Lists the gfile-info attribute keys. 
diff --git a/src/gtk/hello.scm b/src/gtk/hello.scm
index 951ef2c0b..bb31b3022 100644
--- a/src/gtk/hello.scm
+++ b/src/gtk/hello.scm
@@ -1,6 +1,7 @@
 #| -*-Scheme-*-
 
-This is Havoc Pennington's Hello World example from GGAD, wrapped in Scheme. |#
+This is Havoc Pennington's Hello World example
+from GGAD, wrapped in Scheme. |#
 
 (define (hello)
   (let ((window (gtk-window-new 'toplevel))
diff --git a/src/gtk/mit-scheme-pucked-gtk.texi b/src/gtk/mit-scheme-pucked-gtk.texi
index bd70db94b..02259293c 100644
--- a/src/gtk/mit-scheme-pucked-gtk.texi
+++ b/src/gtk/mit-scheme-pucked-gtk.texi
@@ -647,7 +647,7 @@ select widgets by name.
 Gives @var{widget} @var{name}.  The style of the widget (its font,
 colors, etc.) can then be specified using @var{name} in syntax much
 like the id selectors of Cascading Style Sheets (@acronym{CSS}).
-@xref{Gtk CSS Provider}.  Note that the CSS selector syntax allows
+Note that the CSS selector syntax allows
 only alphanumerics, dashes and underscores in widget names.
 @end deffn
 
@@ -1341,6 +1341,7 @@ Type predicate.
 @end deffn
 
 @deffn Procedure set-fix-widget-pointer-shape! widget shape
+@raggedright
 @var{Shape} can be any one of the following symbols:
 @c another thing to check in doc/gtk/check.scm:
 @code{x-cursor},
@@ -1420,6 +1421,7 @@ Type predicate.
 @code{ur-angle},
 @code{watch}, or
 @code{xterm}.
+@end raggedright
 @end deffn
 
 @deffn {Generic Procedure} fix-widget-new-geometry-callback widget