lib: Use @see_also instead of "See also"

This ensures consistent rendering.

See https://developer.gnome.org/gtk-doc-manual/stable/documenting_sections.html.en
This commit is contained in:
Guido Günther 2018-05-29 15:38:25 +02:00
parent 0c180d044f
commit 409b2ccc89
8 changed files with 8 additions and 16 deletions

View file

@ -22,11 +22,10 @@
/**
* SECTION:up-client
* @short_description: Main client object for accessing the UPower daemon
* @see_also: #UpDevice
*
* A helper GObject to use for accessing UPower information, and to be notified
* when it is changed.
*
* See also: #UpDevice
*/
#include "config.h"

View file

@ -22,11 +22,10 @@
/**
* SECTION:up-device
* @short_description: Client object for accessing information about UPower devices
* @see_also: #UpClient
*
* A helper GObject to use for accessing UPower devices, and to be notified
* when it is changed.
*
* See also: #UpClient
*/
#include "config.h"

View file

@ -22,11 +22,10 @@
/**
* SECTION:up-history-item
* @short_description: Helper object representing one item of historical data.
* @see_also: #UpDevice, #UpClient
*
* This object represents one item of data which may be returned from the
* daemon in response to a query.
*
* See also: #UpDevice, #UpClient
*/
#include "config.h"

View file

@ -22,11 +22,10 @@
/**
* SECTION:up-stats-item
* @short_description: Helper object representing one item of statistics data.
* @see_also: #UpDevice, #UpClient
*
* This object represents one item of data which may be returned from the
* daemon in response to a query.
*
* See also: #UpDevice, #UpClient
*/
#include "config.h"

View file

@ -22,11 +22,10 @@
/**
* SECTION:up-types
* @short_description: Types used by UPower and libupower-glib
* @see_also: #UpClient, #UpDevice
*
* These helper functions provide a way to marshal enumerated values to
* text and back again.
*
* See also: #UpClient, #UpDevice
*/
#include "config.h"

View file

@ -22,11 +22,10 @@
/**
* SECTION:up-version
* @short_description: Obtains the version for the installed UPower
* @see_also: #UpClient, #UpDevice
*
* These compile time macros allow the user to enable parts of client code
* depending on the version of libupower-glib installed.
*
* See also: #UpClient, #UpDevice
*/
#if !defined (__UPOWER_H_INSIDE__) && !defined (UP_COMPILATION)

View file

@ -22,11 +22,10 @@
/**
* SECTION:up-wakeup-item
* @short_description: Helper object representing one item of wakeup data.
* @see_also: #UpDevice, #UpClient
*
* This object represents one item of data which may be returned from the
* daemon in response to a query.
*
* See also: #UpDevice, #UpClient
*/
#include "config.h"

View file

@ -22,11 +22,10 @@
/**
* SECTION:upower
* @short_description: Client objects for accessing UPower
* @see_also: #UpClient, #UpDevice
*
* These objects allow client programs to trivially get details about the power
* state, and about devices on the system.
*
* See also: #UpClient, #UpDevice
*/
#ifndef __UPOWER_H__