[glib] Improve various section headings in the docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Improve various section headings in the docs
- Date: Sun, 30 Jun 2013 02:53:12 +0000 (UTC)
commit a3182e3b9a229292be5370542915ae4cc8cc6e25
Author: Matthias Clasen <mclasen redhat com>
Date: Sat Jun 29 22:51:31 2013 -0400
Improve various section headings in the docs
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 | 2 +-
gio/gdbusutils.c | 2 +-
gio/gpollableutils.c | 2 +-
gio/gremoteactiongroup.c | 2 +-
gio/gsettingsschema.c | 2 +-
gio/gtcpwrapperconnection.c | 2 +-
6 files changed, 6 insertions(+), 6 deletions(-)
---
diff --git a/gio/gbytesicon.c b/gio/gbytesicon.c
index 63022af..2182f11 100644
--- a/gio/gbytesicon.c
+++ b/gio/gbytesicon.c
@@ -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
*
diff --git a/gio/gdbusutils.c b/gio/gdbusutils.c
index 1492053..e6d9eaa 100644
--- a/gio/gdbusutils.c
+++ b/gio/gdbusutils.c
@@ -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.
diff --git a/gio/gpollableutils.c b/gio/gpollableutils.c
index 0e653fa..d351034 100644
--- a/gio/gpollableutils.c
+++ b/gio/gpollableutils.c
@@ -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
diff --git a/gio/gremoteactiongroup.c b/gio/gremoteactiongroup.c
index 1b6f342..5e8e884 100644
--- a/gio/gremoteactiongroup.c
+++ b/gio/gremoteactiongroup.c
@@ -29,7 +29,7 @@
/**
* SECTION:gremoteactiongroup
* @title: GRemoteActionGroup
- * @short_description: a #GActionGroup that interacts with other processes
+ * @short_description: A GActionGroup that interacts with other processes
*
* The GRemoteActionGroup interface is implemented by #GActionGroup
* instances that either transmit action invocations to other processes
diff --git a/gio/gsettingsschema.c b/gio/gsettingsschema.c
index 72e71b4..3592836 100644
--- a/gio/gsettingsschema.c
+++ b/gio/gsettingsschema.c
@@ -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
diff --git a/gio/gtcpwrapperconnection.c b/gio/gtcpwrapperconnection.c
index 2f292da..dd4cd85 100644
--- a/gio/gtcpwrapperconnection.c
+++ b/gio/gtcpwrapperconnection.c
@@ -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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]