Improve various section headings in the docs
authorMatthias Clasen <mclasen@redhat.com>
Sun, 30 Jun 2013 02:51:31 +0000 (22:51 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Sun, 30 Jun 2013 02:51:31 +0000 (22:51 -0400)
We don't use # or other forms of links in the section headings.
We also capitalize them and don't put a final period.

This commit corrects several headings to follow these rules.

gio/gbytesicon.c
gio/gdbusutils.c
gio/gpollableutils.c
gio/gremoteactiongroup.c
gio/gsettingsschema.c
gio/gtcpwrapperconnection.c

index 63022af..2182f11 100644 (file)
@@ -34,7 +34,7 @@
 
 /**
  * SECTION:gbytesicon
- * @short_description: An icon stored in memory as a #GBytes
+ * @short_description: An icon stored in memory as a GBytes
  * @include: gio/gio.h
  * @see_also: #GIcon, #GLoadableIcon, #GBytes
  *
index 1492053..e6d9eaa 100644 (file)
@@ -32,7 +32,7 @@
 /**
  * SECTION:gdbusutils
  * @title: D-Bus Utilities
- * @short_description: Various utilities related to D-Bus.
+ * @short_description: Various utilities related to D-Bus
  * @include: gio/gio.h
  *
  * Various utility routines related to D-Bus.
index 0e653fa..d351034 100644 (file)
@@ -28,7 +28,7 @@
 
 /**
  * SECTION:gpollableutils
- * @short_description: #GPollableInputStream / #GPollableOutputStream utilities
+ * @short_description: Utilities for pollable streams
  * @include: gio/gio.h
  *
  * Utility functions for #GPollableInputStream and
index 1b6f342..5e8e884 100644 (file)
@@ -29,7 +29,7 @@
 /**
  * SECTION:gremoteactiongroup
  * @title: GRemoteActionGroup
- * @short_description: a #GActionGroup that interacts with other processes
+ * @short_description: GActionGroup that interacts with other processes
  *
  * The GRemoteActionGroup interface is implemented by #GActionGroup
  * instances that either transmit action invocations to other processes
index 72e71b4..3592836 100644 (file)
@@ -32,7 +32,7 @@
 
 /**
  * SECTION:gsettingsschema
- * @short_description: introspecting and controlling the loading of
+ * @short_description: Introspecting and controlling the loading of
  *                     GSettings schemas
  *
  * The #GSettingsSchemaSource and #GSettingsSchema APIs provide a
index 2f292da..dd4cd85 100644 (file)
@@ -23,7 +23,7 @@
 /**
  * SECTION:gtcpwrapperconnection
  * @title: GTcpWrapperConnection
- * @short_description: wrapper for non-GSocketConnection-based, GSocket-based GIOStreams
+ * @short_description: Wrapper for non-GSocketConnection-based, GSocket-based GIOStreams
  * @see_also: #GSocketConnection.
  *
  * A #GTcpWrapperConnection can be used to wrap a #GIOStream that is