Add includes to all gio docs

This commit is contained in:
Matthias Clasen 2014-01-07 22:55:43 -05:00
parent 86497649bb
commit 3872049445
37 changed files with 46 additions and 8 deletions

View File

@ -31,6 +31,7 @@ G_DEFINE_INTERFACE (GAction, g_action, G_TYPE_OBJECT)
* SECTION:gaction * SECTION:gaction
* @title: GAction * @title: GAction
* @short_description: An action interface * @short_description: An action interface
* @include: gio/gio.h
* *
* #GAction represents a single named action. * #GAction represents a single named action.
* *

View File

@ -28,6 +28,7 @@
* SECTION:gactiongroup * SECTION:gactiongroup
* @title: GActionGroup * @title: GActionGroup
* @short_description: A group of actions * @short_description: A group of actions
* @include: gio/gio.h
* @see_also: #GAction * @see_also: #GAction
* *
* #GActionGroup represents a group of actions. Actions can be used to * #GActionGroup represents a group of actions. Actions can be used to

View File

@ -34,6 +34,7 @@
/** /**
* SECTION:gactiongroupexporter * SECTION:gactiongroupexporter
* @title: GActionGroup exporter * @title: GActionGroup exporter
* @include: gio/gio.h
* @short_description: Export GActionGroups on D-Bus * @short_description: Export GActionGroups on D-Bus
* @see_also: #GActionGroup, #GDBusActionGroup * @see_also: #GActionGroup, #GDBusActionGroup
* *

View File

@ -28,6 +28,7 @@
/** /**
* SECTION:gactionmap * SECTION:gactionmap
* @title: GActionMap * @title: GActionMap
* @include: gio/gio.h
* @short_description: Interface for action containers * @short_description: Interface for action containers
* *
* The GActionMap interface is implemented by #GActionGroup * The GActionMap interface is implemented by #GActionGroup

View File

@ -48,6 +48,7 @@
* SECTION:gapplication * SECTION:gapplication
* @title: GApplication * @title: GApplication
* @short_description: Core application class * @short_description: Core application class
* @include: gio/gio.h
* *
* A #GApplication is the foundation of an application. It wraps some * A #GApplication is the foundation of an application. It wraps some
* low-level platform-specific services and is intended to act as the * low-level platform-specific services and is intended to act as the

View File

@ -43,6 +43,7 @@
* SECTION:gapplicationcommandline * SECTION:gapplicationcommandline
* @title: GApplicationCommandLine * @title: GApplicationCommandLine
* @short_description: A command-line invocation of an application * @short_description: A command-line invocation of an application
* @include: gio/gio.h
* @see_also: #GApplication * @see_also: #GApplication
* *
* #GApplicationCommandLine represents a command-line invocation of * #GApplicationCommandLine represents a command-line invocation of

View File

@ -32,6 +32,7 @@
* SECTION:gdbusactiongroup * SECTION:gdbusactiongroup
* @title: GDBusActionGroup * @title: GDBusActionGroup
* @short_description: A D-Bus GActionGroup implementation * @short_description: A D-Bus GActionGroup implementation
* @include: gio/gio.h
* @see_also: <link linkend="gio-GActionGroup-exporter">GActionGroup exporter</link> * @see_also: <link linkend="gio-GActionGroup-exporter">GActionGroup exporter</link>
* *
* #GDBusActionGroup is an implementation of the #GActionGroup * #GDBusActionGroup is an implementation of the #GActionGroup

View File

@ -31,6 +31,7 @@
* SECTION:gdbusmenumodel * SECTION:gdbusmenumodel
* @title: GDBusMenuModel * @title: GDBusMenuModel
* @short_description: A D-Bus GMenuModel implementation * @short_description: A D-Bus GMenuModel implementation
* @include: gio/gio.h
* @see_also: <link linkend="gio-GMenuModel-exporter">GMenuModel Exporter</link> * @see_also: <link linkend="gio-GMenuModel-exporter">GMenuModel Exporter</link>
* *
* #GDBusMenuModel is an implementation of #GMenuModel that can be used * #GDBusMenuModel is an implementation of #GMenuModel that can be used

View File

@ -45,6 +45,7 @@ struct _GInetAddressPrivate
/** /**
* SECTION:ginetaddress * SECTION:ginetaddress
* @short_description: An IPv4/IPv6 address * @short_description: An IPv4/IPv6 address
* @include: gio/gio.h
* *
* #GInetAddress represents an IPv4 or IPv6 internet address. Use * #GInetAddress represents an IPv4 or IPv6 internet address. Use
* g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to * g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to

View File

@ -33,6 +33,7 @@
/** /**
* SECTION:ginetaddressmask * SECTION:ginetaddressmask
* @short_description: An IPv4/IPv6 address mask * @short_description: An IPv4/IPv6 address mask
* @include: gio/gio.h
* *
* #GInetAddressMask represents a range of IPv4 or IPv6 addresses * #GInetAddressMask represents a range of IPv4 or IPv6 addresses
* described by a base address and a length indicating how many bits * described by a base address and a length indicating how many bits

View File

@ -35,6 +35,7 @@
/** /**
* SECTION:ginetsocketaddress * SECTION:ginetsocketaddress
* @short_description: Internet GSocketAddress * @short_description: Internet GSocketAddress
* @include: gio/gio.h
* *
* An IPv4 or IPv6 socket address; that is, the combination of a * An IPv4 or IPv6 socket address; that is, the combination of a
* #GInetAddress and a port number. * #GInetAddress and a port number.

View File

@ -32,6 +32,7 @@
* SECTION:gmenu * SECTION:gmenu
* @title: GMenu * @title: GMenu
* @short_description: A simple implementation of GMenuModel * @short_description: A simple implementation of GMenuModel
* @include: gio/gio.h
* *
* #GMenu is a simple implementation of #GMenuModel. * #GMenu is a simple implementation of #GMenuModel.
* You populate a #GMenu by adding #GMenuItem instances to it. * You populate a #GMenu by adding #GMenuItem instances to it.

View File

@ -32,6 +32,7 @@
* SECTION:gmenuexporter * SECTION:gmenuexporter
* @title: GMenuModel exporter * @title: GMenuModel exporter
* @short_description: Export GMenuModels on D-Bus * @short_description: Export GMenuModels on D-Bus
* @include: gio/gio.h
* @see_also: #GMenuModel, #GDBusMenuModel * @see_also: #GMenuModel, #GDBusMenuModel
* *
* These functions support exporting a #GMenuModel on D-Bus. * These functions support exporting a #GMenuModel on D-Bus.

View File

@ -27,6 +27,7 @@
* SECTION:gmenumodel * SECTION:gmenumodel
* @title: GMenuModel * @title: GMenuModel
* @short_description: An abstract class representing the contents of a menu * @short_description: An abstract class representing the contents of a menu
* @include: gio/gio.h
* @see_also: #GActionGroup * @see_also: #GActionGroup
* *
* #GMenuModel represents the contents of a menu -- an ordered list of * #GMenuModel represents the contents of a menu -- an ordered list of

View File

@ -29,6 +29,7 @@
/** /**
* SECTION:gnotification * SECTION:gnotification
* @short_description: User Notifications (pop up messages) * @short_description: User Notifications (pop up messages)
* @include: gio/gio.h
* *
* #GNotification is a mechanism for creating a notification to be shown * #GNotification is a mechanism for creating a notification to be shown
* to the user -- typically as a pop-up notification presented by the * to the user -- typically as a pop-up notification presented by the

View File

@ -33,8 +33,9 @@
/** /**
* SECTION:gpermission * SECTION:gpermission
* @title: GPermission * @title: GPermission
* @short_description: An object representing the permission to perform * @short_description: An object representing the permission
* a certain action * to perform a certain action
* @include: gio/gio.h
* *
* A #GPermission represents the status of the caller's permission to * A #GPermission represents the status of the caller's permission to
* perform a certain action. * perform a certain action.

View File

@ -31,6 +31,7 @@
* SECTION:gpropertyaction * SECTION:gpropertyaction
* @title: GPropertyAction * @title: GPropertyAction
* @short_description: A GAction reflecting a GObject property * @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 * A #GPropertyAction is a way to get a #GAction with a state value
* reflecting and controlling the value of a #GObject property. * reflecting and controlling the value of a #GObject property.

View File

@ -31,6 +31,7 @@
/** /**
* SECTION:gproxy * SECTION:gproxy
* @short_description: Interface for proxy handling * @short_description: Interface for proxy handling
* @include: gio/gio.h
* *
* A #GProxy handles connecting to a remote host via a given type of * A #GProxy handles connecting to a remote host via a given type of
* proxy server. It is implemented by the 'gio-proxy' extension point. * proxy server. It is implemented by the 'gio-proxy' extension point.

View File

@ -32,6 +32,7 @@
/** /**
* SECTION:gproxyaddress * SECTION:gproxyaddress
* @short_description: An internet address with proxy information * @short_description: An internet address with proxy information
* @include: gio/gio.h
* *
* Support for proxied #GInetSocketAddress. * Support for proxied #GInetSocketAddress.
*/ */

View File

@ -30,6 +30,7 @@
* SECTION:gremoteactiongroup * SECTION:gremoteactiongroup
* @title: GRemoteActionGroup * @title: GRemoteActionGroup
* @short_description: A GActionGroup that interacts with other processes * @short_description: A GActionGroup that interacts with other processes
* @include: gio/gio.h
* *
* The GRemoteActionGroup interface is implemented by #GActionGroup * The GRemoteActionGroup interface is implemented by #GActionGroup
* instances that either transmit action invocations to other processes * instances that either transmit action invocations to other processes

View File

@ -38,6 +38,7 @@
/** /**
* SECTION:gsettings * SECTION:gsettings
* @short_description: High-level API for application settings * @short_description: High-level API for application settings
* @include: gio/gio.h
* *
* The #GSettings class provides a convenient API for storing and retrieving * The #GSettings class provides a convenient API for storing and retrieving
* application settings. * application settings.

View File

@ -32,8 +32,9 @@
/** /**
* SECTION:gsettingsschema * SECTION:gsettingsschema
* @short_description: Introspecting and controlling the loading of * @short_description: Introspecting and controlling the loading
* GSettings schemas * of GSettings schemas
* @include: gio/gio.h
* *
* The #GSettingsSchemaSource and #GSettingsSchema APIs provide a * The #GSettingsSchemaSource and #GSettingsSchema APIs provide a
* mechanism for advanced control over the loading of schemas and a * mechanism for advanced control over the loading of schemas and a

View File

@ -30,6 +30,7 @@
* SECTION:gsimpleaction * SECTION:gsimpleaction
* @title: GSimpleAction * @title: GSimpleAction
* @short_description: A simple GAction implementation * @short_description: A simple GAction implementation
* @include: gio/gio.h
* *
* A #GSimpleAction is the obvious simple implementation of the #GAction * A #GSimpleAction is the obvious simple implementation of the #GAction
* interface. This is the easiest way to create an action for purposes of * interface. This is the easiest way to create an action for purposes of

View File

@ -31,6 +31,7 @@
* SECTION:gsimpleactiongroup * SECTION:gsimpleactiongroup
* @title: GSimpleActionGroup * @title: GSimpleActionGroup
* @short_description: A simple GActionGroup implementation * @short_description: A simple GActionGroup implementation
* @include: gio/gio.h
* *
* #GSimpleActionGroup is a hash table filled with #GAction objects, * #GSimpleActionGroup is a hash table filled with #GAction objects,
* implementing the #GActionGroup and #GActionMap interfaces. * implementing the #GActionGroup and #GActionMap interfaces.

View File

@ -29,6 +29,7 @@
* SECTION:gsimplepermission * SECTION:gsimplepermission
* @title: GSimplePermission * @title: GSimplePermission
* @short_description: A GPermission that doesn't change value * @short_description: A GPermission that doesn't change value
* @include: gio/gio.h
* *
* #GSimplePermission is a trivial implementation of #GPermission that * #GSimplePermission is a trivial implementation of #GPermission that
* represents a permission that is either always or never allowed. The * represents a permission that is either always or never allowed. The

View File

@ -43,8 +43,9 @@
/** /**
* SECTION:gsocketaddress * SECTION:gsocketaddress
* @short_description: Abstract base class representing endpoints for * @short_description: Abstract base class representing endpoints
* socket communication * for socket communication
* @include: gio/gio.h
* *
* #GSocketAddress is the equivalent of <type>struct sockaddr</type> * #GSocketAddress is the equivalent of <type>struct sockaddr</type>
* in the BSD sockets API. This is an abstract class; use * in the BSD sockets API. This is an abstract class; use

View File

@ -26,6 +26,7 @@
/** /**
* SECTION:gsocketconnectable * SECTION:gsocketconnectable
* @short_description: Interface for potential socket endpoints * @short_description: Interface for potential socket endpoints
* @include: gio/gio.h
* *
* Objects that describe one or more potential socket endpoints * Objects that describe one or more potential socket endpoints
* implement #GSocketConnectable. Callers can then use * implement #GSocketConnectable. Callers can then use

View File

@ -16,6 +16,7 @@
* SECTION:gsocketcontrolmessage * SECTION:gsocketcontrolmessage
* @title: GSocketControlMessage * @title: GSocketControlMessage
* @short_description: A GSocket control message * @short_description: A GSocket control message
* @include: gio/gio.h
* @see_also: #GSocket. * @see_also: #GSocket.
* *
* A #GSocketControlMessage is a special-purpose utility message that * A #GSocketControlMessage is a special-purpose utility message that

View File

@ -43,6 +43,7 @@
* SECTION:gsocketlistener * SECTION:gsocketlistener
* @title: GSocketListener * @title: GSocketListener
* @short_description: Helper for accepting network client connections * @short_description: Helper for accepting network client connections
* @include: gio/gio.h
* @see_also: #GThreadedSocketService, #GSocketService. * @see_also: #GThreadedSocketService, #GSocketService.
* *
* A #GSocketListener is an object that keeps track of a set * A #GSocketListener is an object that keeps track of a set

View File

@ -26,6 +26,7 @@
* SECTION:gsocketservice * SECTION:gsocketservice
* @title: GSocketService * @title: GSocketService
* @short_description: Make it easy to implement a network service * @short_description: Make it easy to implement a network service
* @include: gio/gio.h
* @see_also: #GThreadedSocketService, #GSocketListener. * @see_also: #GThreadedSocketService, #GSocketListener.
* *
* A #GSocketService is an object that represents a service that * A #GSocketService is an object that represents a service that

View File

@ -18,6 +18,7 @@
* SECTION:gsubprocess * SECTION:gsubprocess
* @title: GSubprocess * @title: GSubprocess
* @short_description: Child processes * @short_description: Child processes
* @include: gio/gio.h
* @see_also: #GSubprocessLauncher * @see_also: #GSubprocessLauncher
* *
* #GSubprocess allows the creation of and interaction with child * #GSubprocess allows the creation of and interaction with child

View File

@ -18,6 +18,7 @@
* SECTION:gsubprocesslauncher * SECTION:gsubprocesslauncher
* @title: GSubprocess Launcher * @title: GSubprocess Launcher
* @short_description: Environment options for launching a child process * @short_description: Environment options for launching a child process
* @include: gio/gio.h
* *
* This class contains a set of options for launching child processes, * This class contains a set of options for launching child processes,
* such as where its standard input and output will be directed, the * such as where its standard input and output will be directed, the

View File

@ -27,7 +27,8 @@
/** /**
* SECTION:gtask * SECTION:gtask
* @short_description: Cancellable synchronous or asynchronous task and result * @short_description: Cancellable synchronous or asynchronous task
* and result
* @include: gio/gio.h * @include: gio/gio.h
* @see_also: #GAsyncResult * @see_also: #GAsyncResult
* *

View File

@ -14,6 +14,7 @@
* SECTION:gtcpconnection * SECTION:gtcpconnection
* @title: GTcpConnection * @title: GTcpConnection
* @short_description: A TCP GSocketConnection * @short_description: A TCP GSocketConnection
* @include: gio/gio.h
* @see_also: #GSocketConnection. * @see_also: #GSocketConnection.
* *
* This is the subclass of #GSocketConnection that is created * This is the subclass of #GSocketConnection that is created

View File

@ -23,7 +23,9 @@
/** /**
* SECTION:gtcpwrapperconnection * SECTION:gtcpwrapperconnection
* @title: 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. * @see_also: #GSocketConnection.
* *
* A #GTcpWrapperConnection can be used to wrap a #GIOStream that is * A #GTcpWrapperConnection can be used to wrap a #GIOStream that is

View File

@ -26,6 +26,7 @@
* SECTION:gthreadedsocketservice * SECTION:gthreadedsocketservice
* @title: GThreadedSocketService * @title: GThreadedSocketService
* @short_description: A threaded GSocketService * @short_description: A threaded GSocketService
* @include: gio/gio.h
* @see_also: #GSocketService. * @see_also: #GSocketService.
* *
* A #GThreadedSocketService is a simple subclass of #GSocketService * A #GThreadedSocketService is a simple subclass of #GSocketService

View File

@ -32,6 +32,7 @@
* SECTION:gtlscertificate * SECTION:gtlscertificate
* @title: GTlsCertificate * @title: GTlsCertificate
* @short_description: TLS certificate * @short_description: TLS certificate
* @include: gio/gio.h
* @see_also: #GTlsConnection * @see_also: #GTlsConnection
* *
* A certificate used for TLS authentication and encryption. * A certificate used for TLS authentication and encryption.