From d6d221911d8a8515bf91c9d0721025669717d6f8 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 2 Jul 2008 03:43:13 +0000 Subject: [PATCH] Fix up section comments svn path=/trunk/; revision=7137 --- gobject/ChangeLog | 4 ++++ gobject/gboxed.c | 11 ++++------- gobject/gclosure.c | 6 ++---- gobject/genums.c | 8 +++----- gobject/gobject.c | 9 +++------ gobject/gparam.c | 13 +++++-------- gobject/gparamspecs.c | 9 +++------ gobject/gsignal.c | 17 ++++++++--------- gobject/gtype.c | 8 +++----- gobject/gtypemodule.c | 9 +++------ gobject/gtypeplugin.c | 9 +++------ gobject/gvalue.c | 19 ++++++++----------- gobject/gvaluearray.c | 11 ++++------- 13 files changed, 53 insertions(+), 80 deletions(-) diff --git a/gobject/ChangeLog b/gobject/ChangeLog index b91e2e95e..69491c045 100644 --- a/gobject/ChangeLog +++ b/gobject/ChangeLog @@ -1,3 +1,7 @@ +2008-07-01 Matthias Clasen + + * *.c: Fix up section comments far enough to avoid regressions. + 2008-06-27 Hans Breuer * glib-genmarshal.c : move G_OS_WIN32 inclusion of down to diff --git a/gobject/gboxed.c b/gobject/gboxed.c index 940ad843e..0026b0ad5 100644 --- a/gobject/gboxed.c +++ b/gobject/gboxed.c @@ -32,13 +32,10 @@ /** * SECTION:gboxed - * - * @Short_description: A mechanism to wrap opaque C structures registered - * by the type system - * - * @See_also: #GParamSpecBoxed, g_param_spec_boxed() - * - * @Title: Boxed Types + * @short_description: A mechanism to wrap opaque C structures registered + * by the type system + * @see_also: #GParamSpecBoxed, g_param_spec_boxed() + * @title: Boxed Types * * GBoxed is a generic wrapper mechanism for arbitrary C structures. The only * thing the type system needs to know about the structures is how to copy and diff --git a/gobject/gclosure.c b/gobject/gclosure.c index 389807276..2199d6947 100644 --- a/gobject/gclosure.c +++ b/gobject/gclosure.c @@ -33,10 +33,8 @@ /** * SECTION:gclosure - * - * @Short_description: Functions as first-class objects - * - * @Title: Closures + * @short_description: Functions as first-class objects + * @title: Closures * * A #GClosure represents a callback supplied by the programmer. It * will generally comprise a function of some kind and a marshaller diff --git a/gobject/genums.c b/gobject/genums.c index bf8e3eb14..b49cae597 100644 --- a/gobject/genums.c +++ b/gobject/genums.c @@ -33,14 +33,12 @@ /** * SECTION:enumerations_flags - * - * @Short_description: Enumeration and flags types - * - * @See_also:#GParamSpecEnum, #GParamSpecFlags, g_param_spec_enum(), + * @short_description: Enumeration and flags types + * @see_also:#GParamSpecEnum, #GParamSpecFlags, g_param_spec_enum(), * g_param_spec_flags(), * * glib-mkenums - * @Title: Enumeration and Flag Types + * @title: Enumeration and Flag Types * * The GLib type system provides fundamental types for enumeration and * flags types. (Flags types are like enumerations, but allow their diff --git a/gobject/gobject.c b/gobject/gobject.c index 6a2a3704f..0923c1a72 100644 --- a/gobject/gobject.c +++ b/gobject/gobject.c @@ -41,12 +41,9 @@ /** * SECTION:objects - * - * @Short_description: The base object type - * - * @See_also:#GParamSpecObject, g_param_spec_object() - * - * @Title: The Base Object Type + * @short_description: The base object type + * @see_also: #GParamSpecObject, g_param_spec_object() + * @title: The Base Object Type * * GObject is the fundamental type providing the common attributes and * methods for all object types in GTK+, Pango and other libraries diff --git a/gobject/gparam.c b/gobject/gparam.c index 0f5a52aaf..d981b044e 100644 --- a/gobject/gparam.c +++ b/gobject/gparam.c @@ -33,14 +33,11 @@ /** * SECTION:gparamspec - * - * @Short_description: Metadata for parameter specifications - * - * @See_also:g_object_class_install_property(), g_object_set(), - * g_object_get(), g_object_set_property(), g_object_get_property(), - * g_value_register_transform_func() - * - * @Title: GParamSpec + * @short_description: Metadata for parameter specifications + * @see_also: g_object_class_install_property(), g_object_set(), + * g_object_get(), g_object_set_property(), g_object_get_property(), + * g_value_register_transform_func() + * @title: GParamSpec * * #GParamSpec is an object structure that encapsulates the metadata * required to specify parameters, such as e.g. #GObject properties. diff --git a/gobject/gparamspecs.c b/gobject/gparamspecs.c index ef961d49e..2f49824f4 100644 --- a/gobject/gparamspecs.c +++ b/gobject/gparamspecs.c @@ -33,12 +33,9 @@ /** * SECTION:param_value_types - * - * @Short_description: Standard Parameter and Value Types - * - * @See_also: #GParamSpec, #GValue, g_object_class_install_property(). - * - * @Title: Parameters and Values + * @short_description: Standard Parameter and Value Types + * @see_also: #GParamSpec, #GValue, g_object_class_install_property(). + * @title: Parameters and Values * * #GValue provides an abstract container structure which can be * copied, transformed and compared while holding a value of any diff --git a/gobject/gsignal.c b/gobject/gsignal.c index f9115091e..b662a8d54 100644 --- a/gobject/gsignal.c +++ b/gobject/gsignal.c @@ -41,11 +41,9 @@ /** * SECTION:signals - * - * @Short_description: A means for customization of object behaviour - * and a general purpose notification mechanism - * - * @Title: Signals + * @short_description: A means for customization of object behaviour + * and a general purpose notification mechanism + * @title: Signals * * The basic concept of the signal system is that of the * emission of a signal. Signals are introduced @@ -54,10 +52,11 @@ * basically they are a per-type facility that is inherited. A signal * emission mainly involves invocation of a certain set of callbacks * in precisely defined manner. There are two main categories of such - * callbacks, per-object i'm referring to those types as "object - * types" in the following, simply because that is the context most - * users will encounter signals in. - * + * callbacks, per-object + * Although signals can deal with any kind of instantiatable + * type, i'm referring to those types as "object types" in the following, + * simply because that is the context most users will encounter signals in. + * * ones and user provided ones. * The per-object callbacks are most often referred to as "object method * handler" or "default (signal) handler", while user provided callbacks are diff --git a/gobject/gtype.c b/gobject/gtype.c index 3c08569df..079d44ed7 100644 --- a/gobject/gtype.c +++ b/gobject/gtype.c @@ -34,11 +34,9 @@ /** * SECTION:gtype - * - * @Short_description: The GLib Runtime type identification and - * management system - * - * @Title:Type Information + * @short_description: The GLib Runtime type identification and + * management system + * @title:Type Information * * The GType API is the foundation of the GObject system. It provides the * facilities for registering and managing all fundamental data types, diff --git a/gobject/gtypemodule.c b/gobject/gtypemodule.c index 8749c1efb..07e315770 100644 --- a/gobject/gtypemodule.c +++ b/gobject/gtypemodule.c @@ -28,10 +28,8 @@ /** * SECTION:gtypemodule - * - * @Short_description: Type loading modules - * - * @See_also: + * @short_description: Type loading modules + * @see_also: * * #GTypePlugin * The abstract type loader interface. @@ -41,8 +39,7 @@ * Portable mechanism for dynamically loaded modules. * * - * - * @Title: GTypeModule + * @title: GTypeModule * * #GTypeModule provides a simple implementation of the #GTypePlugin * interface. The model of #GTypeModule is a dynamically loaded module diff --git a/gobject/gtypeplugin.c b/gobject/gtypeplugin.c index f8588fe9a..3dbd13e3b 100644 --- a/gobject/gtypeplugin.c +++ b/gobject/gtypeplugin.c @@ -25,12 +25,9 @@ /** * SECTION:gtypeplugin - * - * @Short_description: An interface for dynamically loadable types - * - * @See_also:#GTypeModule and g_type_register_dynamic(). - * - * @Titile: GTypePlugin + * @short_description: An interface for dynamically loadable types + * @see_also: #GTypeModule and g_type_register_dynamic(). + * @title: GTypePlugin * * The GObject type system supports dynamic loading of types. The * #GTypePlugin interface is used to handle the lifecycle of diff --git a/gobject/gvalue.c b/gobject/gvalue.c index b14d28c5f..02089f6f1 100644 --- a/gobject/gvalue.c +++ b/gobject/gvalue.c @@ -33,17 +33,14 @@ /** * SECTION:generic_values - * - * @Short_description: A polymorphic type that can hold values of any - * other type - * - * @See_also: The fundamental types which all support #GValue - * operations and thus can be used as a type initializer for - * g_value_init() are defined by a separate interface. See the Standard - * Values API for details. - * - * @Title: Generic values + * @short_description: A polymorphic type that can hold values of any + * other type + * @see_also: The fundamental types which all support #GValue + * operations and thus can be used as a type initializer for + * g_value_init() are defined by a separate interface. See the Standard + * Values API for details. + * @title: Generic values * * The #GValue structure is basically a variable container that consists * of a type identifier and a specific value of that type. diff --git a/gobject/gvaluearray.c b/gobject/gvaluearray.c index 2137e357a..889a7f5ab 100644 --- a/gobject/gvaluearray.c +++ b/gobject/gvaluearray.c @@ -32,13 +32,10 @@ /** * SECTION:value_arrays - * - * @Short_description: A container structure to maintain an array of - * generic values - * - * @See_also:#GValue, #GParamSpecValueArray, g_param_spec_value_array() - * - * @Title: Value arrays + * @short_description: A container structure to maintain an array of + * generic values + * @see_also: #GValue, #GParamSpecValueArray, g_param_spec_value_array() + * @title: Value arrays * * The prime purpose of a #GValueArray is for it to be used as an * object property that holds an array of values. A #GValueArray wraps