[glib] Add includes to all gio docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Add includes to all gio docs
- Date: Wed, 8 Jan 2014 03:55:59 +0000 (UTC)
commit 38720494452aa336eb2f168ac4bd2add138c400e
Author: Matthias Clasen <mclasen redhat com>
Date: Tue Jan 7 22:55:43 2014 -0500
Add includes to all gio docs
gio/gaction.c | 1 +
gio/gactiongroup.c | 1 +
gio/gactiongroupexporter.c | 1 +
gio/gactionmap.c | 1 +
gio/gapplication.c | 1 +
gio/gapplicationcommandline.c | 1 +
gio/gdbusactiongroup.c | 1 +
gio/gdbusmenumodel.c | 1 +
gio/ginetaddress.c | 1 +
gio/ginetaddressmask.c | 1 +
gio/ginetsocketaddress.c | 1 +
gio/gmenu.c | 1 +
gio/gmenuexporter.c | 1 +
gio/gmenumodel.c | 1 +
gio/gnotification.c | 1 +
gio/gpermission.c | 5 +++--
gio/gpropertyaction.c | 1 +
gio/gproxy.c | 1 +
gio/gproxyaddress.c | 1 +
gio/gremoteactiongroup.c | 1 +
gio/gsettings.c | 1 +
gio/gsettingsschema.c | 5 +++--
gio/gsimpleaction.c | 1 +
gio/gsimpleactiongroup.c | 1 +
gio/gsimplepermission.c | 1 +
gio/gsocketaddress.c | 5 +++--
gio/gsocketconnectable.c | 1 +
gio/gsocketcontrolmessage.c | 1 +
gio/gsocketlistener.c | 1 +
gio/gsocketservice.c | 1 +
gio/gsubprocess.c | 1 +
gio/gsubprocesslauncher.c | 1 +
gio/gtask.c | 3 ++-
gio/gtcpconnection.c | 1 +
gio/gtcpwrapperconnection.c | 4 +++-
gio/gthreadedsocketservice.c | 1 +
gio/gtlscertificate.c | 1 +
37 files changed, 46 insertions(+), 8 deletions(-)
---
diff --git a/gio/gaction.c b/gio/gaction.c
index 77cbe70..a2332ff 100644
--- a/gio/gaction.c
+++ b/gio/gaction.c
@@ -31,6 +31,7 @@ G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)
* SECTION:gaction
* @title: GAction
* @short_description: An action interface
+ * @include: gio/gio.h
*
* #GAction represents a single named action.
*
diff --git a/gio/gactiongroup.c b/gio/gactiongroup.c
index 30e5e13..5fe1dc7 100644
--- a/gio/gactiongroup.c
+++ b/gio/gactiongroup.c
@@ -28,6 +28,7 @@
* SECTION:gactiongroup
* @title: GActionGroup
* @short_description: A group of actions
+ * @include: gio/gio.h
* @see_also: #GAction
*
* #GActionGroup represents a group of actions. Actions can be used to
diff --git a/gio/gactiongroupexporter.c b/gio/gactiongroupexporter.c
index 33824b7..4871de0 100644
--- a/gio/gactiongroupexporter.c
+++ b/gio/gactiongroupexporter.c
@@ -34,6 +34,7 @@
/**
* SECTION:gactiongroupexporter
* @title: GActionGroup exporter
+ * @include: gio/gio.h
* @short_description: Export GActionGroups on D-Bus
* @see_also: #GActionGroup, #GDBusActionGroup
*
diff --git a/gio/gactionmap.c b/gio/gactionmap.c
index 0987ae1..bd42224 100644
--- a/gio/gactionmap.c
+++ b/gio/gactionmap.c
@@ -28,6 +28,7 @@
/**
* SECTION:gactionmap
* @title: GActionMap
+ * @include: gio/gio.h
* @short_description: Interface for action containers
*
* The GActionMap interface is implemented by #GActionGroup
diff --git a/gio/gapplication.c b/gio/gapplication.c
index 40d8393..1ffefe8 100644
--- a/gio/gapplication.c
+++ b/gio/gapplication.c
@@ -48,6 +48,7 @@
* SECTION:gapplication
* @title: GApplication
* @short_description: Core application class
+ * @include: gio/gio.h
*
* A #GApplication is the foundation of an application. It wraps some
* low-level platform-specific services and is intended to act as the
diff --git a/gio/gapplicationcommandline.c b/gio/gapplicationcommandline.c
index 9a0840f..693cfff 100644
--- a/gio/gapplicationcommandline.c
+++ b/gio/gapplicationcommandline.c
@@ -43,6 +43,7 @@
* SECTION:gapplicationcommandline
* @title: GApplicationCommandLine
* @short_description: A command-line invocation of an application
+ * @include: gio/gio.h
* @see_also: #GApplication
*
* #GApplicationCommandLine represents a command-line invocation of
diff --git a/gio/gdbusactiongroup.c b/gio/gdbusactiongroup.c
index a3deb04..81fa13c 100644
--- a/gio/gdbusactiongroup.c
+++ b/gio/gdbusactiongroup.c
@@ -32,6 +32,7 @@
* SECTION:gdbusactiongroup
* @title: GDBusActionGroup
* @short_description: A D-Bus GActionGroup implementation
+ * @include: gio/gio.h
* @see_also: <link linkend="gio-GActionGroup-exporter">GActionGroup exporter</link>
*
* #GDBusActionGroup is an implementation of the #GActionGroup
diff --git a/gio/gdbusmenumodel.c b/gio/gdbusmenumodel.c
index c437dcf..16467d1 100644
--- a/gio/gdbusmenumodel.c
+++ b/gio/gdbusmenumodel.c
@@ -31,6 +31,7 @@
* SECTION:gdbusmenumodel
* @title: GDBusMenuModel
* @short_description: A D-Bus GMenuModel implementation
+ * @include: gio/gio.h
* @see_also: <link linkend="gio-GMenuModel-exporter">GMenuModel Exporter</link>
*
* #GDBusMenuModel is an implementation of #GMenuModel that can be used
diff --git a/gio/ginetaddress.c b/gio/ginetaddress.c
index 2db01cb..13f3757 100644
--- a/gio/ginetaddress.c
+++ b/gio/ginetaddress.c
@@ -45,6 +45,7 @@ struct _GInetAddressPrivate
/**
* SECTION:ginetaddress
* @short_description: An IPv4/IPv6 address
+ * @include: gio/gio.h
*
* #GInetAddress represents an IPv4 or IPv6 internet address. Use
* g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to
diff --git a/gio/ginetaddressmask.c b/gio/ginetaddressmask.c
index f88689e..428ad8a 100644
--- a/gio/ginetaddressmask.c
+++ b/gio/ginetaddressmask.c
@@ -33,6 +33,7 @@
/**
* SECTION:ginetaddressmask
* @short_description: An IPv4/IPv6 address mask
+ * @include: gio/gio.h
*
* #GInetAddressMask represents a range of IPv4 or IPv6 addresses
* described by a base address and a length indicating how many bits
diff --git a/gio/ginetsocketaddress.c b/gio/ginetsocketaddress.c
index 2328dbd..87b0d49 100644
--- a/gio/ginetsocketaddress.c
+++ b/gio/ginetsocketaddress.c
@@ -35,6 +35,7 @@
/**
* SECTION:ginetsocketaddress
* @short_description: Internet GSocketAddress
+ * @include: gio/gio.h
*
* An IPv4 or IPv6 socket address; that is, the combination of a
* #GInetAddress and a port number.
diff --git a/gio/gmenu.c b/gio/gmenu.c
index 39c267a..68f23ab 100644
--- a/gio/gmenu.c
+++ b/gio/gmenu.c
@@ -32,6 +32,7 @@
* SECTION:gmenu
* @title: GMenu
* @short_description: A simple implementation of GMenuModel
+ * @include: gio/gio.h
*
* #GMenu is a simple implementation of #GMenuModel.
* You populate a #GMenu by adding #GMenuItem instances to it.
diff --git a/gio/gmenuexporter.c b/gio/gmenuexporter.c
index 0f405ee..fc5dffd 100644
--- a/gio/gmenuexporter.c
+++ b/gio/gmenuexporter.c
@@ -32,6 +32,7 @@
* SECTION:gmenuexporter
* @title: GMenuModel exporter
* @short_description: Export GMenuModels on D-Bus
+ * @include: gio/gio.h
* @see_also: #GMenuModel, #GDBusMenuModel
*
* These functions support exporting a #GMenuModel on D-Bus.
diff --git a/gio/gmenumodel.c b/gio/gmenumodel.c
index ce79f34..3d9d17e 100644
--- a/gio/gmenumodel.c
+++ b/gio/gmenumodel.c
@@ -27,6 +27,7 @@
* SECTION:gmenumodel
* @title: GMenuModel
* @short_description: An abstract class representing the contents of a menu
+ * @include: gio/gio.h
* @see_also: #GActionGroup
*
* #GMenuModel represents the contents of a menu -- an ordered list of
diff --git a/gio/gnotification.c b/gio/gnotification.c
index 4add232..b61a198 100644
--- a/gio/gnotification.c
+++ b/gio/gnotification.c
@@ -29,6 +29,7 @@
/**
* SECTION:gnotification
* @short_description: User Notifications (pop up messages)
+ * @include: gio/gio.h
*
* #GNotification is a mechanism for creating a notification to be shown
* to the user -- typically as a pop-up notification presented by the
diff --git a/gio/gpermission.c b/gio/gpermission.c
index d781c3a..421d63a 100644
--- a/gio/gpermission.c
+++ b/gio/gpermission.c
@@ -33,8 +33,9 @@
/**
* SECTION:gpermission
* @title: GPermission
- * @short_description: An object representing the permission to perform
- * a certain action
+ * @short_description: An object representing the permission
+ * to perform a certain action
+ * @include: gio/gio.h
*
* A #GPermission represents the status of the caller's permission to
* perform a certain action.
diff --git a/gio/gpropertyaction.c b/gio/gpropertyaction.c
index 5e90c7a..46a19b4 100644
--- a/gio/gpropertyaction.c
+++ b/gio/gpropertyaction.c
@@ -31,6 +31,7 @@
* SECTION:gpropertyaction
* @title: GPropertyAction
* @short_description: A GAction reflecting a GObject property
+ * @include: gio/gio.h
*
* A #GPropertyAction is a way to get a #GAction with a state value
* reflecting and controlling the value of a #GObject property.
diff --git a/gio/gproxy.c b/gio/gproxy.c
index 475759f..e1fadf7 100644
--- a/gio/gproxy.c
+++ b/gio/gproxy.c
@@ -31,6 +31,7 @@
/**
* SECTION:gproxy
* @short_description: Interface for proxy handling
+ * @include: gio/gio.h
*
* A #GProxy handles connecting to a remote host via a given type of
* proxy server. It is implemented by the 'gio-proxy' extension point.
diff --git a/gio/gproxyaddress.c b/gio/gproxyaddress.c
index 8d7a3bf..c03f648 100644
--- a/gio/gproxyaddress.c
+++ b/gio/gproxyaddress.c
@@ -32,6 +32,7 @@
/**
* SECTION:gproxyaddress
* @short_description: An internet address with proxy information
+ * @include: gio/gio.h
*
* Support for proxied #GInetSocketAddress.
*/
diff --git a/gio/gremoteactiongroup.c b/gio/gremoteactiongroup.c
index 5e8e884..e00d916 100644
--- a/gio/gremoteactiongroup.c
+++ b/gio/gremoteactiongroup.c
@@ -30,6 +30,7 @@
* SECTION:gremoteactiongroup
* @title: GRemoteActionGroup
* @short_description: A GActionGroup that interacts with other processes
+ * @include: gio/gio.h
*
* The GRemoteActionGroup interface is implemented by #GActionGroup
* instances that either transmit action invocations to other processes
diff --git a/gio/gsettings.c b/gio/gsettings.c
index 0cc69a0..6d01f35 100644
--- a/gio/gsettings.c
+++ b/gio/gsettings.c
@@ -38,6 +38,7 @@
/**
* SECTION:gsettings
* @short_description: High-level API for application settings
+ * @include: gio/gio.h
*
* The #GSettings class provides a convenient API for storing and retrieving
* application settings.
diff --git a/gio/gsettingsschema.c b/gio/gsettingsschema.c
index 78d68ab..eb1ac57 100644
--- a/gio/gsettingsschema.c
+++ b/gio/gsettingsschema.c
@@ -32,8 +32,9 @@
/**
* SECTION:gsettingsschema
- * @short_description: Introspecting and controlling the loading of
- * GSettings schemas
+ * @short_description: Introspecting and controlling the loading
+ * of GSettings schemas
+ * @include: gio/gio.h
*
* The #GSettingsSchemaSource and #GSettingsSchema APIs provide a
* mechanism for advanced control over the loading of schemas and a
diff --git a/gio/gsimpleaction.c b/gio/gsimpleaction.c
index c694808..5ee9806 100644
--- a/gio/gsimpleaction.c
+++ b/gio/gsimpleaction.c
@@ -30,6 +30,7 @@
* SECTION:gsimpleaction
* @title: GSimpleAction
* @short_description: A simple GAction implementation
+ * @include: gio/gio.h
*
* A #GSimpleAction is the obvious simple implementation of the #GAction
* interface. This is the easiest way to create an action for purposes of
diff --git a/gio/gsimpleactiongroup.c b/gio/gsimpleactiongroup.c
index ce4921c..717b2f6 100644
--- a/gio/gsimpleactiongroup.c
+++ b/gio/gsimpleactiongroup.c
@@ -31,6 +31,7 @@
* SECTION:gsimpleactiongroup
* @title: GSimpleActionGroup
* @short_description: A simple GActionGroup implementation
+ * @include: gio/gio.h
*
* #GSimpleActionGroup is a hash table filled with #GAction objects,
* implementing the #GActionGroup and #GActionMap interfaces.
diff --git a/gio/gsimplepermission.c b/gio/gsimplepermission.c
index 9eee4f4..e913d14 100644
--- a/gio/gsimplepermission.c
+++ b/gio/gsimplepermission.c
@@ -29,6 +29,7 @@
* SECTION:gsimplepermission
* @title: GSimplePermission
* @short_description: A GPermission that doesn't change value
+ * @include: gio/gio.h
*
* #GSimplePermission is a trivial implementation of #GPermission that
* represents a permission that is either always or never allowed. The
diff --git a/gio/gsocketaddress.c b/gio/gsocketaddress.c
index 90f22be..844035f 100644
--- a/gio/gsocketaddress.c
+++ b/gio/gsocketaddress.c
@@ -43,8 +43,9 @@
/**
* SECTION:gsocketaddress
- * @short_description: Abstract base class representing endpoints for
- * socket communication
+ * @short_description: Abstract base class representing endpoints
+ * for socket communication
+ * @include: gio/gio.h
*
* #GSocketAddress is the equivalent of <type>struct sockaddr</type>
* in the BSD sockets API. This is an abstract class; use
diff --git a/gio/gsocketconnectable.c b/gio/gsocketconnectable.c
index b4efc99..d4911e5 100644
--- a/gio/gsocketconnectable.c
+++ b/gio/gsocketconnectable.c
@@ -26,6 +26,7 @@
/**
* SECTION:gsocketconnectable
* @short_description: Interface for potential socket endpoints
+ * @include: gio/gio.h
*
* Objects that describe one or more potential socket endpoints
* implement #GSocketConnectable. Callers can then use
diff --git a/gio/gsocketcontrolmessage.c b/gio/gsocketcontrolmessage.c
index 1f257bc..a526b4f 100644
--- a/gio/gsocketcontrolmessage.c
+++ b/gio/gsocketcontrolmessage.c
@@ -16,6 +16,7 @@
* SECTION:gsocketcontrolmessage
* @title: GSocketControlMessage
* @short_description: A GSocket control message
+ * @include: gio/gio.h
* @see_also: #GSocket.
*
* A #GSocketControlMessage is a special-purpose utility message that
diff --git a/gio/gsocketlistener.c b/gio/gsocketlistener.c
index 8d6b19e..72eca31 100644
--- a/gio/gsocketlistener.c
+++ b/gio/gsocketlistener.c
@@ -43,6 +43,7 @@
* SECTION:gsocketlistener
* @title: GSocketListener
* @short_description: Helper for accepting network client connections
+ * @include: gio/gio.h
* @see_also: #GThreadedSocketService, #GSocketService.
*
* A #GSocketListener is an object that keeps track of a set
diff --git a/gio/gsocketservice.c b/gio/gsocketservice.c
index 97e7dcd..c088390 100644
--- a/gio/gsocketservice.c
+++ b/gio/gsocketservice.c
@@ -26,6 +26,7 @@
* SECTION:gsocketservice
* @title: GSocketService
* @short_description: Make it easy to implement a network service
+ * @include: gio/gio.h
* @see_also: #GThreadedSocketService, #GSocketListener.
*
* A #GSocketService is an object that represents a service that
diff --git a/gio/gsubprocess.c b/gio/gsubprocess.c
index 780463c..8bc4852 100644
--- a/gio/gsubprocess.c
+++ b/gio/gsubprocess.c
@@ -18,6 +18,7 @@
* SECTION:gsubprocess
* @title: GSubprocess
* @short_description: Child processes
+ * @include: gio/gio.h
* @see_also: #GSubprocessLauncher
*
* #GSubprocess allows the creation of and interaction with child
diff --git a/gio/gsubprocesslauncher.c b/gio/gsubprocesslauncher.c
index 7b1ca48..b61fc58 100644
--- a/gio/gsubprocesslauncher.c
+++ b/gio/gsubprocesslauncher.c
@@ -18,6 +18,7 @@
* SECTION:gsubprocesslauncher
* @title: GSubprocess Launcher
* @short_description: Environment options for launching a child process
+ * @include: gio/gio.h
*
* This class contains a set of options for launching child processes,
* such as where its standard input and output will be directed, the
diff --git a/gio/gtask.c b/gio/gtask.c
index 07a3210..bc2744d 100644
--- a/gio/gtask.c
+++ b/gio/gtask.c
@@ -27,7 +27,8 @@
/**
* SECTION:gtask
- * @short_description: Cancellable synchronous or asynchronous task and result
+ * @short_description: Cancellable synchronous or asynchronous task
+ * and result
* @include: gio/gio.h
* @see_also: #GAsyncResult
*
diff --git a/gio/gtcpconnection.c b/gio/gtcpconnection.c
index 2348c31..00e8470 100644
--- a/gio/gtcpconnection.c
+++ b/gio/gtcpconnection.c
@@ -14,6 +14,7 @@
* SECTION:gtcpconnection
* @title: GTcpConnection
* @short_description: A TCP GSocketConnection
+ * @include: gio/gio.h
* @see_also: #GSocketConnection.
*
* This is the subclass of #GSocketConnection that is created
diff --git a/gio/gtcpwrapperconnection.c b/gio/gtcpwrapperconnection.c
index dd4cd85..e62da8e 100644
--- a/gio/gtcpwrapperconnection.c
+++ b/gio/gtcpwrapperconnection.c
@@ -23,7 +23,9 @@
/**
* SECTION:gtcpwrapperconnection
* @title: GTcpWrapperConnection
- * @short_description: Wrapper for non-GSocketConnection-based, GSocket-based GIOStreams
+ * @short_description: Wrapper for non-GSocketConnection-based,
+ * GSocket-based GIOStreams
+ * @include: gio/gio.h
* @see_also: #GSocketConnection.
*
* A #GTcpWrapperConnection can be used to wrap a #GIOStream that is
diff --git a/gio/gthreadedsocketservice.c b/gio/gthreadedsocketservice.c
index 84e0a18..5316280 100644
--- a/gio/gthreadedsocketservice.c
+++ b/gio/gthreadedsocketservice.c
@@ -26,6 +26,7 @@
* SECTION:gthreadedsocketservice
* @title: GThreadedSocketService
* @short_description: A threaded GSocketService
+ * @include: gio/gio.h
* @see_also: #GSocketService.
*
* A #GThreadedSocketService is a simple subclass of #GSocketService
diff --git a/gio/gtlscertificate.c b/gio/gtlscertificate.c
index ea5f1df..b8ee3fc 100644
--- a/gio/gtlscertificate.c
+++ b/gio/gtlscertificate.c
@@ -32,6 +32,7 @@
* SECTION:gtlscertificate
* @title: GTlsCertificate
* @short_description: TLS certificate
+ * @include: gio/gio.h
* @see_also: #GTlsConnection
*
* A certificate used for TLS authentication and encryption.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]