Commit 38720494 authored by Matthias Clasen's avatar Matthias Clasen

Add includes to all gio docs

parent 86497649
......@@ -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.
*
......
......@@ -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
......
......@@ -34,6 +34,7 @@
/**
* SECTION:gactiongroupexporter
* @title: GActionGroup exporter
* @include: gio/gio.h
* @short_description: Export GActionGroups on D-Bus
* @see_also: #GActionGroup, #GDBusActionGroup
*
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -32,6 +32,7 @@
/**
* SECTION:gproxyaddress
* @short_description: An internet address with proxy information
* @include: gio/gio.h
*
* Support for proxied #GInetSocketAddress.
*/
......
......@@ -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
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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
*
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment