diff --git a/doc/Makefile.am b/doc/Makefile.am index 3628c6c649089730fc308c50ee6120551e3a9387..d11a150117104460f6fc682105c8fb880cd4c070 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -12,7 +12,7 @@ DOC_MODULE=UPower DOC_MAIN_SGML_FILE=upower-docs.xml # Extra options to supply to gtkdoc-scan -SCAN_OPTIONS=--ignore-headers=config.h +SCAN_OPTIONS=--ignore-headers=config.h --rebuild-types --rebuild-sections # The directory containing the source code. Relative to $(srcdir) DOC_SOURCE_DIR=../libupower-glib diff --git a/libupower-glib/up-client.c b/libupower-glib/up-client.c index 6a487801830b6b5b2dfaf6adbd22c55ea691c884..1491a9847a8ce3458195eef876f29b03c3e424c8 100644 --- a/libupower-glib/up-client.c +++ b/libupower-glib/up-client.c @@ -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" @@ -152,7 +151,7 @@ up_client_get_devices2 (UpClient *client) * @client: a #UpClient instance. * * Get the composite display device. - * Return value: (transfer full): a #UpClient object, or %NULL on error. + * Return value: (transfer full): a #UpDevice object, or %NULL on error. * * Since: 1.0 **/ @@ -525,7 +524,7 @@ up_client_finalize (GObject *object) * @error: Return location for error or %NULL. * * Creates a new #UpClient object. If connecting to upowerd on D-Bus fails, - % this returns %NULL and sets @error. + * this returns %NULL and sets @error. * * Return value: a new UpClient object, or %NULL on failure. * diff --git a/libupower-glib/up-client.h b/libupower-glib/up-client.h index 2342a48a1c7de3182389837acfa0e5f4e6c6bc2e..0180dd475b6bac246731c98d8d191d5dc71368ff 100644 --- a/libupower-glib/up-client.h +++ b/libupower-glib/up-client.h @@ -44,15 +44,15 @@ G_BEGIN_DECLS typedef struct _UpClientPrivate UpClientPrivate; -typedef struct -{ +typedef struct { GObject parent; UpClientPrivate *priv; } UpClient; -typedef struct -{ +typedef struct { + /*< private >*/ GObjectClass parent_class; + /*< public >*/ void (*device_added) (UpClient *client, UpDevice *device); void (*device_removed) (UpClient *client, diff --git a/libupower-glib/up-device.c b/libupower-glib/up-device.c index 8bfd98a24e1aed7d2eb1fbb29a68a4d2a4b1950e..2f2c4cf44df70f57f3f89f7a5c901e5f2a554bee 100644 --- a/libupower-glib/up-device.c +++ b/libupower-glib/up-device.c @@ -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" diff --git a/libupower-glib/up-device.h b/libupower-glib/up-device.h index 5186796da82bc9d9432e2345d5027cb32be7982a..22d168af3470d26e4701a8c9377010f8e14fa487 100644 --- a/libupower-glib/up-device.h +++ b/libupower-glib/up-device.h @@ -44,16 +44,14 @@ G_BEGIN_DECLS typedef struct _UpDevicePrivate UpDevicePrivate; -typedef struct -{ +typedef struct { GObject parent; UpDevicePrivate *priv; } UpDevice; -typedef struct -{ - GObjectClass parent_class; +typedef struct { /*< private >*/ + GObjectClass parent_class; /* Padding for future expansion */ void (*_up_device_reserved1) (void); void (*_up_device_reserved2) (void); diff --git a/libupower-glib/up-history-item.c b/libupower-glib/up-history-item.c index bb8e4e4bf48381806bbcf5fa39acbab1974e9e41..19f4c5d05398578394b6e14983d571e2d77f1d74 100644 --- a/libupower-glib/up-history-item.c +++ b/libupower-glib/up-history-item.c @@ -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" diff --git a/libupower-glib/up-history-item.h b/libupower-glib/up-history-item.h index 83780601994a0f11b5c13e945be458c349eaa495..0175cdf94749731ed7a4a6f7f732eaaaf7d78ada 100644 --- a/libupower-glib/up-history-item.h +++ b/libupower-glib/up-history-item.h @@ -40,14 +40,12 @@ G_BEGIN_DECLS typedef struct UpHistoryItemPrivate UpHistoryItemPrivate; -typedef struct -{ +typedef struct { GObject parent; UpHistoryItemPrivate *priv; } UpHistoryItem; -typedef struct -{ +typedef struct { GObjectClass parent_class; } UpHistoryItemClass; diff --git a/libupower-glib/up-stats-item.c b/libupower-glib/up-stats-item.c index afa9f7e77cd30a9c3ef2397352d037d986af8ec2..555aa3a382a04cf756871e7a1090ad3c3ef6cf2c 100644 --- a/libupower-glib/up-stats-item.c +++ b/libupower-glib/up-stats-item.c @@ -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" diff --git a/libupower-glib/up-stats-item.h b/libupower-glib/up-stats-item.h index 85b8a6df3e234fa09bb5ef3583eb5615c601e259..ee6c33c09f048a9dc792ad60328167ce890f8fd9 100644 --- a/libupower-glib/up-stats-item.h +++ b/libupower-glib/up-stats-item.h @@ -39,14 +39,12 @@ G_BEGIN_DECLS typedef struct UpStatsItemPrivate UpStatsItemPrivate; -typedef struct -{ +typedef struct { GObject parent; UpStatsItemPrivate *priv; } UpStatsItem; -typedef struct -{ +typedef struct { GObjectClass parent_class; } UpStatsItemClass; diff --git a/libupower-glib/up-types.c b/libupower-glib/up-types.c index 0984ad90ae5655139072a468b50c90789b219356..525cd0268d7c693ac31ab94f2b5ac7a0fa1047ed 100644 --- a/libupower-glib/up-types.c +++ b/libupower-glib/up-types.c @@ -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" diff --git a/libupower-glib/up-version.h.in b/libupower-glib/up-version.h.in index 9d502fb2efdaa444d67e98bfb1e47f1e253d2523..f2bd261a550f3eb52a8c2845272959ad05b2f2c0 100644 --- a/libupower-glib/up-version.h.in +++ b/libupower-glib/up-version.h.in @@ -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) diff --git a/libupower-glib/up-wakeup-item.c b/libupower-glib/up-wakeup-item.c index c11f7a758edbb1265dcee401d1467a50f8b70382..cefbe62e675bda24f7b4c4d6a82ddd2d70bcd49e 100644 --- a/libupower-glib/up-wakeup-item.c +++ b/libupower-glib/up-wakeup-item.c @@ -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" diff --git a/libupower-glib/up-wakeup-item.h b/libupower-glib/up-wakeup-item.h index 3e32559e7425c769ca76d34fcf748bfc724779bd..e0dd6b31502355f7373eae296d86cc60c8314920 100644 --- a/libupower-glib/up-wakeup-item.h +++ b/libupower-glib/up-wakeup-item.h @@ -40,14 +40,12 @@ G_BEGIN_DECLS typedef struct UpWakeupItemPrivate UpWakeupItemPrivate; -typedef struct -{ +typedef struct { GObject parent; UpWakeupItemPrivate *priv; } UpWakeupItem; -typedef struct -{ +typedef struct { GObjectClass parent_class; } UpWakeupItemClass; diff --git a/libupower-glib/upower.h b/libupower-glib/upower.h index 681bc2b2304b34a4e1a598e4ce0b19da919c6126..3d7c98e717755990eb0b9fdf1fa73d9210e7ec1a 100644 --- a/libupower-glib/upower.h +++ b/libupower-glib/upower.h @@ -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__