summaryrefslogtreecommitdiff
path: root/glib
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2011-11-12 21:54:42 -0500
committerMatthias Clasen <mclasen@redhat.com>2011-11-12 21:54:42 -0500
commit06bb6c75a2e5e6e0c3bfcb99ae829143768e1702 (patch)
tree92ddf0f6f514672395866e1d3980f7b4fc002c38 /glib
parent599f254066beb3bdad1d4fb70a7afd28c45d7634 (diff)
downloadglib-06bb6c75a2e5e6e0c3bfcb99ae829143768e1702.tar.gz
More consistent doc formatting
Move some things around, make capitalization of short descriptions more consistent.
Diffstat (limited to 'glib')
-rw-r--r--glib/gchecksum.c2
-rw-r--r--glib/gconvert.c2
-rw-r--r--glib/gdatetime.c2
-rw-r--r--glib/ghmac.c2
-rw-r--r--glib/glist.c4
-rw-r--r--glib/gslist.c4
-rw-r--r--glib/gtimezone.c2
-rw-r--r--glib/gurifuncs.c7
-rw-r--r--glib/gversion.c2
9 files changed, 12 insertions, 15 deletions
diff --git a/glib/gchecksum.c b/glib/gchecksum.c
index f7844f2bb..a503ddf8b 100644
--- a/glib/gchecksum.c
+++ b/glib/gchecksum.c
@@ -35,7 +35,7 @@
/**
* SECTION:checksum
* @title: Data Checksums
- * @short_description: Computes the checksum for data
+ * @short_description: computes the checksum for data
*
* GLib provides a generic API for computing checksums (or "digests")
* for a sequence of arbitrary bytes, using various hashing algorithms
diff --git a/glib/gconvert.c b/glib/gconvert.c
index aa64203de..517b7b432 100644
--- a/glib/gconvert.c
+++ b/glib/gconvert.c
@@ -69,7 +69,7 @@
/**
* SECTION:conversions
* @title: Character Set Conversion
- * @short_description: Convert strings between different character sets
+ * @short_description: convert strings between different character sets
*
* The g_convert() family of function wraps the functionality of iconv(). In
* addition to pure character set conversions, GLib has functions to deal
diff --git a/glib/gdatetime.c b/glib/gdatetime.c
index 65c403373..4306cca23 100644
--- a/glib/gdatetime.c
+++ b/glib/gdatetime.c
@@ -81,7 +81,7 @@
/**
* SECTION:date-time
* @title: GDateTime
- * @short_description: A structure representing Date and Time
+ * @short_description: a structure representing Date and Time
* @see_also: #GTimeZone
*
* #GDateTime is a structure that combines a Gregorian date and time
diff --git a/glib/ghmac.c b/glib/ghmac.c
index ef26177c7..90ebf93b6 100644
--- a/glib/ghmac.c
+++ b/glib/ghmac.c
@@ -39,7 +39,7 @@
/**
* SECTION:hmac
* @title: Secure HMAC Digests
- * @short_description: Computes the HMAC for data
+ * @short_description: computes the HMAC for data
*
* HMACs should be used when producing a cookie or hash based on data
* and a key. Simple mechanisms for using SHA1 and other algorithms to
diff --git a/glib/glist.c b/glib/glist.c
index 91794d993..7378c2516 100644
--- a/glib/glist.c
+++ b/glib/glist.c
@@ -38,9 +38,7 @@
/**
* SECTION:linked_lists_double
* @title: Doubly-Linked Lists
- * @short_description: linked lists containing integer values or
- * pointers to data, with the ability to iterate
- * over the list in both directions
+ * @short_description: linked lists that can be iterated over in both directions
*
* The #GList structure and its associated functions provide a standard
* doubly-linked list data structure.
diff --git a/glib/gslist.c b/glib/gslist.c
index e99971e8e..89e0f2d60 100644
--- a/glib/gslist.c
+++ b/glib/gslist.c
@@ -38,9 +38,7 @@
/**
* SECTION:linked_lists_single
* @title: Singly-Linked Lists
- * @short_description: linked lists containing integer values or
- * pointers to data, limited to iterating over the
- * list in one direction
+ * @short_description: linked lists that can be iterated in one direction
*
* The #GSList structure and its associated functions provide a
* standard singly-linked list data structure.
diff --git a/glib/gtimezone.c b/glib/gtimezone.c
index 84dad84cf..efb273386 100644
--- a/glib/gtimezone.c
+++ b/glib/gtimezone.c
@@ -39,7 +39,7 @@
/**
* SECTION:timezone
* @title: GTimeZone
- * @short_description: A structure representing a time zone
+ * @short_description: a structure representing a time zone
* @see_also: #GDateTime
*
* #GTimeZone is a structure that represents a time zone, at no
diff --git a/glib/gurifuncs.c b/glib/gurifuncs.c
index 6a77244c6..25b098d29 100644
--- a/glib/gurifuncs.c
+++ b/glib/gurifuncs.c
@@ -35,9 +35,10 @@
/**
* SECTION:gurifuncs
- * @short_description: URI Functions
- *
- * Functions for manipulating Universal Resource Identifiers (URIs) as
+ * @title: URI Functions
+ * @short_description: manipulating URIs
+ *
+ * Functions for manipulating Universal Resource Identifiers (URIs) as
* defined by <ulink url="http://www.ietf.org/rfc/rfc3986.txt">
* RFC 3986</ulink>. It is highly recommended that you have read and
* understand RFC 3986 for understanding this API.
diff --git a/glib/gversion.c b/glib/gversion.c
index 96d46ff54..d80e262e8 100644
--- a/glib/gversion.c
+++ b/glib/gversion.c
@@ -31,7 +31,7 @@
/**
* SECTION:version
* @Title: Version Information
- * @Short_description: Variables and functions to check the GLib version
+ * @Short_description: variables and functions to check the GLib version
*
* GLib provides version information, primarily useful in configure
* checks for builds that have a configure script. Applications will