Fix up section comments

svn path=/trunk/; revision=7137
This commit is contained in:
Matthias Clasen 2008-07-02 03:43:13 +00:00
parent ee96535cec
commit d6d221911d
13 changed files with 53 additions and 80 deletions

View File

@ -1,3 +1,7 @@
2008-07-01 Matthias Clasen <mclasen@redhat.com>
* *.c: Fix up section comments far enough to avoid regressions.
2008-06-27 Hans Breuer <hans@breuer.org>
* glib-genmarshal.c : move G_OS_WIN32 inclusion of <io.h> down to

View File

@ -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

View File

@ -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

View File

@ -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(),
*
* <link linkend="glib-mkenums">glib-mkenums</link>
* @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

View File

@ -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

View File

@ -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.

View File

@ -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

View File

@ -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
* <emphasis>emission</emphasis> 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
* <footnote><para>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.
* </para></footnote>
* 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

View File

@ -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,

View File

@ -28,10 +28,8 @@
/**
* SECTION:gtypemodule
*
* @Short_description: Type loading modules
*
* @See_also:<variablelist>
* @short_description: Type loading modules
* @see_also:<variablelist>
* <varlistentry>
* <term>#GTypePlugin</term>
* <listitem><para>The abstract type loader interface.</para></listitem>
@ -41,8 +39,7 @@
* <listitem><para>Portable mechanism for dynamically loaded modules.</para></listitem>
* </varlistentry>
* </variablelist>
*
* @Title: GTypeModule
* @title: GTypeModule
*
* #GTypeModule provides a simple implementation of the #GTypePlugin
* interface. The model of #GTypeModule is a dynamically loaded module

View File

@ -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

View File

@ -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 <link
* linkend="gobject-Standard-Parameter-and-Value-Types">Standard
* Values API</link> 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 <link
* linkend="gobject-Standard-Parameter-and-Value-Types">Standard
* Values API</link> 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.

View File

@ -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