[nautilus-actions] Reference manual: Fix NAObject documentation
- From: Pierre Wieser <pwieser src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nautilus-actions] Reference manual: Fix NAObject documentation
- Date: Sat, 11 Dec 2010 15:10:44 +0000 (UTC)
commit b9cfa7c76db9ce28017e4d1b89052f2b8f96d2bd
Author: Pierre Wieser <pwieser trychlos org>
Date: Sat Dec 11 16:11:40 2010 +0100
Reference manual: Fix NAObject documentation
ChangeLog | 54 +++++++++++++
docs/reference/nautilus-actions-docs.xml | 18 +++--
docs/reference/nautilus-actions-sections.txt | 12 ++-
src/api/na-data-boxed.h | 37 +++++++++
src/api/na-data-def.h | 11 +++
src/api/na-data-types.h | 7 ++
src/api/na-iexporter.h | 35 +++++++++
src/api/na-ifactory-object.h | 46 +++++++++++
src/api/na-ifactory-provider.h | 104 ++++++++++++++++++++++++++
src/api/na-iimporter.h | 35 +++++++++
src/api/na-iio-provider.h | 62 +++++++++++++++
src/api/na-object.h | 77 ++++++++++++-------
src/core/na-data-boxed.c | 36 ---------
src/core/na-data-def.c | 11 ---
src/core/na-data-types.c | 7 --
src/core/na-export-format.c | 16 ++--
src/core/na-export-format.h | 21 +++---
src/core/na-exporter.h | 5 +-
src/core/na-factory-object.h | 4 +-
src/core/na-factory-provider.c | 4 +-
src/core/na-factory-provider.h | 4 +-
src/core/na-gnome-vfs-uri.c | 6 +-
src/core/na-gnome-vfs-uri.h | 8 +-
src/core/na-gtk-utils.c | 2 +-
src/core/na-gtk-utils.h | 5 +-
src/core/na-iabout.c | 8 +-
src/core/na-iabout.h | 19 +++--
src/core/na-iexporter.c | 35 ---------
src/core/na-ifactory-object.c | 46 -----------
src/core/na-ifactory-provider.c | 104 --------------------------
src/core/na-iimporter.c | 35 ---------
src/core/na-iio-provider.c | 62 ---------------
src/core/na-importer-ask.c | 4 +-
src/core/na-importer-ask.h | 24 +++---
src/core/na-importer.h | 6 +-
src/core/na-io-provider.c | 4 +-
src/core/na-io-provider.h | 24 +++---
src/core/na-ipivot-consumer.c | 20 +++---
src/core/na-ipivot-consumer.h | 33 ++++----
src/core/na-iprefs.c | 22 +++---
src/core/na-iprefs.h | 18 ++--
src/core/na-module.c | 16 ++--
src/core/na-module.h | 23 +++---
src/core/na-object.c | 69 ++++++++++++-----
src/core/na-pivot.c | 38 +++++-----
src/core/na-pivot.h | 23 +++---
src/core/na-selected-info.c | 40 +++++-----
src/core/na-selected-info.h | 23 +++---
src/core/na-tokens.c | 12 ++--
src/core/na-tokens.h | 23 +++---
src/core/na-updater.c | 18 ++--
src/core/na-updater.h | 23 +++---
52 files changed, 757 insertions(+), 642 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index f26d90f..8d5ed15 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,59 @@
2010-12-11 Pierre Wieser <pwieser trychlos org>
+ Fix NAObject documentation.
+
+ * docs/reference/nautilus-actions-docs.xml
+ * docs/reference/nautilus-actions-sections.txt:
+ * src/api/na-data-boxed.h:
+ * src/api/na-data-def.h:
+ * src/api/na-data-types.h:
+ * src/api/na-iexporter.h:
+ * src/api/na-ifactory-object.h:
+ * src/api/na-ifactory-provider.h:
+ * src/api/na-iimporter.h:
+ * src/api/na-iio-provider.h:
+ * src/api/na-object.h:
+ * src/core/na-data-boxed.c:
+ * src/core/na-data-def.c:
+ * src/core/na-data-types.c:
+ * src/core/na-export-format.c:
+ * src/core/na-export-format.h:
+ * src/core/na-exporter.h:
+ * src/core/na-factory-object.h:
+ * src/core/na-factory-provider.c:
+ * src/core/na-factory-provider.h:
+ * src/core/na-gnome-vfs-uri.c:
+ * src/core/na-gnome-vfs-uri.h:
+ * src/core/na-gtk-utils.c:
+ * src/core/na-gtk-utils.h:
+ * src/core/na-iabout.c:
+ * src/core/na-iabout.h:
+ * src/core/na-iexporter.c:
+ * src/core/na-ifactory-object.c:
+ * src/core/na-ifactory-provider.c:
+ * src/core/na-iimporter.c:
+ * src/core/na-iio-provider.c:
+ * src/core/na-importer-ask.c:
+ * src/core/na-importer-ask.h:
+ * src/core/na-importer.h:
+ * src/core/na-io-provider.c:
+ * src/core/na-io-provider.h:
+ * src/core/na-ipivot-consumer.c:
+ * src/core/na-ipivot-consumer.h:
+ * src/core/na-iprefs.c:
+ * src/core/na-iprefs.h:
+ * src/core/na-module.c:
+ * src/core/na-module.h:
+ * src/core/na-object.c:
+ * src/core/na-pivot.c:
+ * src/core/na-pivot.h:
+ * src/core/na-selected-info.c:
+ * src/core/na-selected-info.h:
+ * src/core/na-tokens.c:
+ * src/core/na-tokens.h:
+ * src/core/na-updater.c:
+ * src/core/na-updater.h: Updated accordingly.
+
Fix D-Bus Services documentation.
* docs/reference/nautilus-actions-docs.xml:
diff --git a/docs/reference/nautilus-actions-docs.xml b/docs/reference/nautilus-actions-docs.xml
index de42886..c3cf5de 100644
--- a/docs/reference/nautilus-actions-docs.xml
+++ b/docs/reference/nautilus-actions-docs.xml
@@ -68,19 +68,23 @@
</chapter>
<chapter>
- <title>Others (nautilus-actions-api.xml title)</title>
+ <title>NAObject Hierarchy</title>
+ <xi:include href="xml/object.xml"/>
<xi:include href="xml/na-object-id.xml"/>
- <xi:include href="xml/na-object-action.xml"/>
- <xi:include href="xml/na-icontext.xml"/>
- <xi:include href="xml/na-gconf-monitor.xml"/>
- <xi:include href="xml/na-object-menu.xml"/>
<xi:include href="xml/na-object-item.xml"/>
- <xi:include href="xml/na-object.xml"/>
+ <xi:include href="xml/na-object-action.xml"/>
<xi:include href="xml/na-object-profile.xml"/>
+ <xi:include href="xml/na-object-menu.xml"/>
<xi:include href="xml/na-iduplicable.xml"/>
+ <xi:include href="xml/na-icontext.xml"/>
+ <xi:include href="xml/na-object-api.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Miscellaneous API</title>
+ <xi:include href="xml/na-gconf-monitor.xml"/>
<xi:include href="xml/na-gconf-utils.xml"/>
<xi:include href="xml/na-core-utils.xml"/>
- <xi:include href="xml/na-object-api.xml"/>
</chapter>
<chapter id="object-tree">
diff --git a/docs/reference/nautilus-actions-sections.txt b/docs/reference/nautilus-actions-sections.txt
index 6126a06..01e23c6 100644
--- a/docs/reference/nautilus-actions-sections.txt
+++ b/docs/reference/nautilus-actions-sections.txt
@@ -262,11 +262,11 @@ NAFO_DATA_CAPABILITITES
<SECTION>
<FILE>object</FILE>
-<TITLE>NAObject</TITLE>
NA_OBJECT_TYPE
-NAObjectPrivate
-NAObjectClassPrivate
+NA_OBJECT
+NA_IS_OBJECT
NAObject
+NAObjectClass
na_object_object_check_status
na_object_object_check_status_up
na_object_object_reset_origin
@@ -281,12 +281,14 @@ na_object_free_hierarchy
na_object_object_debug_invalid
<SUBSECTION Standard>
-NA_OBJECT
-NA_IS_OBJECT
na_object_object_get_type
NA_OBJECT_CLASS
NA_IS_OBJECT_CLASS
NA_OBJECT_GET_CLASS
+
+<SUBSECTION Private>
+NAObjectPrivate
+NAObjectClassPrivate
</SECTION>
<SECTION>
diff --git a/src/api/na-data-boxed.h b/src/api/na-data-boxed.h
index 2125f6f..694cedb 100644
--- a/src/api/na-data-boxed.h
+++ b/src/api/na-data-boxed.h
@@ -31,6 +31,42 @@
#ifndef __NAUTILUS_ACTIONS_API_NA_DATA_BOXED_H__
#define __NAUTILUS_ACTIONS_API_NA_DATA_BOXED_H__
+/**
+ * SECTION: data-boxed
+ * @title: NADataBoxed
+ * @short_description: The Data Factory Element Class Definition
+ * @include: nautilus-actions/na-data-boxed.h
+ *
+ * The object which encapsulates an elementary data of #NAIFactoryObject.
+ * A #NADataBoxed object has a type and a value.
+ *
+ * <refsect2>
+ * <title>Versions historic</title>
+ * <table>
+ * <title>Historic of the versions of the #NADataBoxed interface</title>
+ * <tgroup rowsep="1" colsep="1" align="center" cols="3">
+ * <colspec colname="na-version" />
+ * <colspec colname="api-version" />
+ * <colspec colname="current" />
+ * <thead>
+ * <row>
+ * <entry>&prodname; version</entry>
+ * <entry>#NADataBoxed interface version</entry>
+ * <entry></entry>
+ * </row>
+ * </thead>
+ * <tbody>
+ * <row>
+ * <entry>since 2.30</entry>
+ * <entry>1</entry>
+ * <entry>current version</entry>
+ * </row>
+ * </tbody>
+ * </tgroup>
+ * </table>
+ * </refsect2>
+ */
+
#include <glib-object.h>
#include "na-data-def.h"
@@ -56,6 +92,7 @@ typedef struct {
typedef struct NADataBoxedClassPrivate NADataBoxedClassPrivate;
typedef struct {
+ /*< private >*/
GObjectClass parent;
NADataBoxedClassPrivate *private;
}
diff --git a/src/api/na-data-def.h b/src/api/na-data-def.h
index 3ca49b7..cc9ca87 100644
--- a/src/api/na-data-def.h
+++ b/src/api/na-data-def.h
@@ -31,6 +31,17 @@
#ifndef __NAUTILUS_ACTIONS_API_NA_FACTORY_DATA_DEF_H__
#define __NAUTILUS_ACTIONS_API_NA_FACTORY_DATA_DEF_H__
+/**
+ * SECTION: data-def
+ * @title: NADataDef, NADataGroup
+ * @short_description: The Data Factory Structure Definitions
+ * @include: nautilus-actions/na-data-def.h
+ *
+ * #NADataDef and #NADataGroup are structures which handle the list of
+ * elementary datas for each and every #NAObjectItem which happens to
+ * implement the #NAIFactoryObject interface.
+ */
+
#include <glib.h>
G_BEGIN_DECLS
diff --git a/src/api/na-data-types.h b/src/api/na-data-types.h
index ea978a6..4317134 100644
--- a/src/api/na-data-types.h
+++ b/src/api/na-data-types.h
@@ -31,6 +31,13 @@
#ifndef __NAUTILUS_ACTIONS_API_NA_FACTORY_DATA_TYPES_H__
#define __NAUTILUS_ACTIONS_API_NA_FACTORY_DATA_TYPES_H__
+/**
+ * SECTION: data-type
+ * @title: NADataType
+ * @short_description: The Data Factory Type Definitions
+ * @include: nautilus-actions/na-data-types.h
+ */
+
#include <glib.h>
G_BEGIN_DECLS
diff --git a/src/api/na-iexporter.h b/src/api/na-iexporter.h
index 5a71a93..a5c89b9 100644
--- a/src/api/na-iexporter.h
+++ b/src/api/na-iexporter.h
@@ -31,6 +31,41 @@
#ifndef __NAUTILUS_ACTIONS_API_NA_IEXPORTER_H__
#define __NAUTILUS_ACTIONS_API_NA_IEXPORTER_H__
+/**
+ * SECTION: iexporter
+ * @title: NAIExporter
+ * @short_description: The Export Interface v 1
+ * @include: nautilus-actions/na-iexporter.h
+ *
+ * The #NAIExporter interface exports items to the outside world.
+ *
+ * <refsect2>
+ * <title>Versions historic</title>
+ * <table>
+ * <title>Historic of the versions of the #NAIExporter interface</title>
+ * <tgroup rowsep="1" colsep="1" align="center" cols="3">
+ * <colspec colname="na-version" />
+ * <colspec colname="api-version" />
+ * <colspec colname="current" />
+ * <thead>
+ * <row>
+ * <entry>&prodname; version</entry>
+ * <entry>#NAIExporter interface version</entry>
+ * <entry></entry>
+ * </row>
+ * </thead>
+ * <tbody>
+ * <row>
+ * <entry>since 2.30</entry>
+ * <entry>1</entry>
+ * <entry>current version</entry>
+ * </row>
+ * </tbody>
+ * </tgroup>
+ * </table>
+ * </refsect2>
+ */
+
#include "na-object-item.h"
G_BEGIN_DECLS
diff --git a/src/api/na-ifactory-object.h b/src/api/na-ifactory-object.h
index 42440ab..fa8a3bc 100644
--- a/src/api/na-ifactory-object.h
+++ b/src/api/na-ifactory-object.h
@@ -31,6 +31,52 @@
#ifndef __NAUTILUS_ACTIONS_API_NA_IFACTORY_OBJECT_H__
#define __NAUTILUS_ACTIONS_API_NA_IFACTORY_OBJECT_H__
+/**
+ * SECTION: ifactory-object
+ * @title: NAIFactoryObject
+ * @short_description: The #NAObjectItem Interface v 1
+ * @include: nautilus-actions/na-ifactory_object.h
+ *
+ * This interface is implemented by #NAObjectItem derived objects so that they
+ * can take advantage of our data factory management system.
+ *
+ * A #NAObjectItem derived object which would implement this #NAIFactoryObject
+ * interface must meet following conditions:
+ * <itemizedlist>
+ * <listitem>
+ * <para>
+ * accept an empty constructor
+ * </para>
+ * </listitem>
+ * </itemizedlist>
+ *
+ * <refsect2>
+ * <title>Versions historic</title>
+ * <table>
+ * <title>Historic of the versions of the #NAIFactoryObject interface</title>
+ * <tgroup rowsep="1" colsep="1" align="center" cols="3">
+ * <colspec colname="na-version" />
+ * <colspec colname="api-version" />
+ * <colspec colname="current" />
+ * <thead>
+ * <row>
+ * <entry>&prodname; version</entry>
+ * <entry>#NAIFactoryObject interface version</entry>
+ * <entry></entry>
+ * </row>
+ * </thead>
+ * <tbody>
+ * <row>
+ * <entry>since 2.30</entry>
+ * <entry>1</entry>
+ * <entry>current version</entry>
+ * </row>
+ * </tbody>
+ * </tgroup>
+ * </table>
+ * </refsect2>
+ */
+
#include "na-data-def.h"
#include "na-data-boxed.h"
#include "na-ifactory-provider-provider.h"
diff --git a/src/api/na-ifactory-provider.h b/src/api/na-ifactory-provider.h
index c8442a1..e8e7b98 100644
--- a/src/api/na-ifactory-provider.h
+++ b/src/api/na-ifactory-provider.h
@@ -31,6 +31,110 @@
#ifndef __NAUTILUS_ACTIONS_API_NA_IFACTORY_PROVIDER_H__
#define __NAUTILUS_ACTIONS_API_NA_IFACTORY_PROVIDER_H__
+/**
+ * SECTION: ifactory-provider
+ * @title: NAIFactoryProvider
+ * @short_description: The Data Factory Provider Interface v 1
+ * @include: nautilus-actions/na-ifactory_provider.h
+ *
+ * &prodname; has to deal with a relatively great number of elementary datas,
+ * reading them from different supports, storing and displaying them,
+ * then re-writing these same datas, with several output formats, and so on.
+ *
+ * This has rapidly become a pain, if not just a bug generator.
+ * Each new data must be described, have a schema to be stored in
+ * (historical storage subsystem) GConf; import and export assistants
+ * must be carefully updated to export the new data...
+ *
+ * The #NAIFactoryProvider aims to simplify and organize all the work
+ * which must be done around each and every elementary data. It is based
+ * on three main things:
+ *
+ * <orderedlist>
+ * <listitem>
+ * <formalpara>
+ * <title>Elementary datas are banalized.</title>
+ * <para>
+ * whether they are a string, an integer, a boolean, a simple
+ * or double-linked list, each elementary data is encapsuled
+ * into a #NADataBoxed, small sort of structure (incidentally,
+ * which acts almost as the new GLib #GVariant, but too late,
+ * guys :)).
+ * </para>
+ * </formalpara>
+ * </listitem>
+ * <listitem>
+ * <formalpara>
+ * <title>Our objects are de-structured.</title>
+ * <para>
+ * Instead of organizing our elementary datas into structures,
+ * our objects are just flat lists of #NADataBoxed.
+ * </para>
+ * </formalpara>
+ * </listitem>
+ * <listitem>
+ * <formalpara>
+ * <title>A full, centralized, data dictionary is defined.</title>
+ * <para>
+ * Now that our elementary datas are banalized and de-structured,
+ * it is simple enough to describe each of these datas with all
+ * iss properties in one single, centralized, place.
+ * </para>
+ * </formalpara>
+ * </listitem>
+ * </orderedlist>
+ *
+ * Of course, I/O providers are good candidates to be users of this
+ * #NAIFactoryProvider interface.
+ *
+ * Without this interface, each and every I/O provider must,
+ * for example when reading an item, have the list of data to be
+ * readen for each item, then read each individual data, then
+ * organize them in a I/O structure..
+ * Each time a new data is added to an object, as e.g. a new condition,
+ * then all available I/O providers must be updated: read the data,
+ * write the data, then display the data, and so on..
+ *
+ * With this #NAIFactoryProvider interface, the I/O provider has just to
+ * deal with reading/writing elementary types. It does need to know that
+ * it will have to read, name, tooltip, description. It just needs to know
+ * how to read a string.
+ * And while we do not introduce another data type, the I/O provider
+ * does not need any maintenance even if we add lot of new data, conditions
+ * labels, and so on.
+ *
+ * So, this is the interface used by data factory management system for
+ * providing serialization/unserialization services. This interface may
+ * be implemented by I/O providers which would take advantage of this
+ * system.
+ *
+ * <refsect2>
+ * <title>Versions historic</title>
+ * <table>
+ * <title>Historic of the versions of the #NAIFactoryProvider interface</title>
+ * <tgroup rowsep="1" colsep="1" align="center" cols="3">
+ * <colspec colname="na-version" />
+ * <colspec colname="api-version" />
+ * <colspec colname="current" />
+ * <thead>
+ * <row>
+ * <entry>&prodname; version</entry>
+ * <entry>#NAIFactoryProvider interface version</entry>
+ * <entry></entry>
+ * </row>
+ * </thead>
+ * <tbody>
+ * <row>
+ * <entry>since 2.30</entry>
+ * <entry>1</entry>
+ * <entry>current version</entry>
+ * </row>
+ * </tbody>
+ * </tgroup>
+ * </table>
+ * </refsect2>
+ */
+
#include "na-data-boxed.h"
#include "na-ifactory-object.h"
#include "na-ifactory-provider-provider.h"
diff --git a/src/api/na-iimporter.h b/src/api/na-iimporter.h
index 0431fc4..e1e7156 100644
--- a/src/api/na-iimporter.h
+++ b/src/api/na-iimporter.h
@@ -31,6 +31,41 @@
#ifndef __NAUTILUS_ACTIONS_API_NA_IIMPORTER_H__
#define __NAUTILUS_ACTIONS_API_NA_IIMPORTER_H__
+/**
+ * SECTION: iimporter
+ * @title: NAIImporter
+ * @short_description: The Import Interface v 1
+ * @include: nautilus-actions/na-iimporter.h
+ *
+ * The #NAIImporter interface imports items from the outside world.
+ *
+ * <refsect2>
+ * <title>Versions historic</title>
+ * <table>
+ * <title>Historic of the versions of the #NAIImporter interface</title>
+ * <tgroup rowsep="1" colsep="1" align="center" cols="3">
+ * <colspec colname="na-version" />
+ * <colspec colname="api-version" />
+ * <colspec colname="current" />
+ * <thead>
+ * <row>
+ * <entry>&prodname; version</entry>
+ * <entry>#NAIImporter interface version</entry>
+ * <entry></entry>
+ * </row>
+ * </thead>
+ * <tbody>
+ * <row>
+ * <entry>since 2.30</entry>
+ * <entry>1</entry>
+ * <entry>current version</entry>
+ * </row>
+ * </tbody>
+ * </tgroup>
+ * </table>
+ * </refsect2>
+ */
+
#include "na-object-item.h"
G_BEGIN_DECLS
diff --git a/src/api/na-iio-provider.h b/src/api/na-iio-provider.h
index d86f10b..cbadb8c 100644
--- a/src/api/na-iio-provider.h
+++ b/src/api/na-iio-provider.h
@@ -31,6 +31,68 @@
#ifndef __NAUTILUS_ACTIONS_API_NA_IIO_PROVIDER_H__
#define __NAUTILUS_ACTIONS_API_NA_IIO_PROVIDER_H__
+/**
+ * SECTION: iio-provider
+ * @title: NAIIOProvider
+ * @short_description: The I/O Provider Interface v 1
+ * @include: nautilus-actions/na-iio-provider.h
+ *
+ * The #NAIIOProvider interface is defined in order to let internal
+ * and external plugins provide read and write accesses
+ * to an alternate storage subsystem.
+ *
+ * The #NAIIOProvider interface provides three types of services:
+ * <itemizedlist>
+ * <listitem>
+ * <para>
+ * load all items at startup;
+ * </para>
+ * </listitem>
+ * <listitem>
+ * <para>
+ * create, update or delete items via the management user interface;
+ * </para>
+ * </listitem>
+ * <listitem>
+ * <para>
+ * inform &prodname; when an item has been modified on the
+ * underlying storage subsystem.
+ * </para>
+ * </listitem>
+ * </itemizedlist>
+ *
+ * These services may be fully implemented by the I/O provider itself.
+ * Or, the I/O provider may also prefer to take advantage of the data
+ * factory management (see #NAIFactoryObject and #NAIFactoryProvider
+ * interfaces).
+ *
+ * <refsect2>
+ * <title>Versions historic</title>
+ * <table>
+ * <title>Historic of the versions of the #NAIIOProvider interface</title>
+ * <tgroup rowsep="1" colsep="1" align="center" cols="3">
+ * <colspec colname="na-version" />
+ * <colspec colname="api-version" />
+ * <colspec colname="current" />
+ * <thead>
+ * <row>
+ * <entry>&prodname; version</entry>
+ * <entry>#NAIIOProvider interface version</entry>
+ * <entry></entry>
+ * </row>
+ * </thead>
+ * <tbody>
+ * <row>
+ * <entry>since 2.30</entry>
+ * <entry>1</entry>
+ * <entry>current version</entry>
+ * </row>
+ * </tbody>
+ * </tgroup>
+ * </table>
+ * </refsect2>
+ */
+
#include "na-object-item.h"
G_BEGIN_DECLS
diff --git a/src/api/na-object.h b/src/api/na-object.h
index 801d564..b5b5a56 100644
--- a/src/api/na-object.h
+++ b/src/api/na-object.h
@@ -33,102 +33,125 @@
/**
* SECTION: object
- * @short_description: #NAObject class definition.
+ * @title: NAObject
+ * @short_description: The #NAObject Base Class Definition
* @include: nautilus-actions/na-object.h
*
- * This is the base class of all our data object hierarchy.
+ * This is the base class of all our data object hierarchy. #NAObject is
+ * supposed to be used as a pure virtual base class, i.e. should only be
+ * derived.
*/
#include <glib-object.h>
G_BEGIN_DECLS
-#define NA_OBJECT_TYPE ( na_object_object_get_type())
-#define NA_OBJECT( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_TYPE, NAObject ))
-#define NA_OBJECT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_TYPE, NAObjectClass ))
-#define NA_IS_OBJECT( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_TYPE ))
-#define NA_IS_OBJECT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_TYPE ))
-#define NA_OBJECT_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_TYPE, NAObjectClass ))
+#define NA_OBJECT_TYPE ( na_object_object_get_type())
+#define NA_OBJECT( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_OBJECT_TYPE, NAObject ))
+#define NA_OBJECT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_OBJECT_TYPE, NAObjectClass ))
+#define NA_IS_OBJECT( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_OBJECT_TYPE ))
+#define NA_IS_OBJECT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_OBJECT_TYPE ))
+#define NA_OBJECT_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_OBJECT_TYPE, NAObjectClass ))
-typedef struct NAObjectPrivate NAObjectPrivate;
+typedef struct _NAObjectPrivate NAObjectPrivate;
typedef struct {
+ /*< private >*/
GObject parent;
NAObjectPrivate *private;
}
NAObject;
-typedef struct NAObjectClassPrivate NAObjectClassPrivate;
+typedef struct _NAObjectClassPrivate NAObjectClassPrivate;
+/**
+ * NAObjectClass:
+ * @dump: Dumps the #NAObject -part of the #NAObject -derived object.
+ * @copy: Copies a #NAObject to another.
+ * @are_equal: Tests if two #NAObject are equal.
+ * @is_valid: Tests if a #NAObject is valid.
+ *
+ * The #NAObjectClass defines some methods available to derived classes.
+ */
typedef struct {
+ /*< private >*/
GObjectClass parent;
NAObjectClassPrivate *private;
+ /*< public >*/
/**
* dump:
- * @object: the #NAObject-derived object to be dumped.
+ * @object: the NAObject-derived object to be dumped.
*
* Dumps via g_debug the content of the object.
*
- * #NAObject class takes care of calling this function for each
+ * NAObject class takes care of calling this function for each
* derived class, starting from topmost base class up to most-
* derived one. Each derived class has so only to take care of
* dumping its own data.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void ( *dump ) ( const NAObject *object );
/**
* copy:
- * @target: the #NAObject-derived object which will receive data.
- * @source: the #NAObject-derived object which will provide data.
+ * @target: the NAObject-derived object which will receive data.
+ * @source: the NAObject-derived object which will provide data.
* @recursive: whether children should be recursively copied.
*
* Copies data and properties from @source to @target.
*
* Each derived class should take care of implementing this function
- * when relevant. #NAObject class will take care of calling this
+ * when relevant. NAObject class will take care of calling this
* function for each class of the hierarchy, starting from topmost
* base class up to the most-derived one. Each class has so only to
* take care of dumping its own data.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void ( *copy ) ( NAObject *target, const NAObject *source, gboolean recursive );
/**
* are_equal:
- * @a: a first #NAObject object.
- * @b: a second #NAObject object to be compared to the first one.
+ * @a: a first NAObject object.
+ * @b: a second NAObject object to be compared to the first one.
*
* Compares the two objects.
*
- * Returns: %TRUE if @a and @b are identical, %FALSE else.
- *
* Each derived class should take care of implementing this function
- * when relevant. #NAObject class will take care of calling this
+ * when relevant. NAObject class will take care of calling this
* function for each class of the hierarchy, starting from topmost
* base class up to the most-derived one, at least while result
- * stays at %TRUE.
+ * stays at TRUE.
* As soon as a difference is detected, the calling sequence will
* be stopped, and the result returned.
+ *
+ * Returns: TRUE if @a and @b are identical, FALSE else.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
gboolean ( *are_equal )( const NAObject *a, const NAObject *b );
/**
* is_valid:
- * @object: the #NAObject object to be checked.
+ * @object: the NAObject object to be checked.
*
* Checks @object for validity.
*
- * Returns: %TRUE if @object is valid, %FALSE else.
- *
- * A #NAObject is valid if its internal identifiant is set.
+ * A NAObject is valid if its internal identifiant is set.
*
* Each derived class should take care of implementing this function
- * when relevant. #NAObject class will take care of calling this
+ * when relevant. NAObject class will take care of calling this
* function for each class of the hierarchy, starting from topmost
* base class up to the most-derived one, at least while result
- * stays at %TRUE.
+ * stays at TRUE.
* As soon as a difference is detected, the calling sequence will
* be stopped, and the result returned.
+ *
+ * Returns: TRUE if @object is valid, FALSE else.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
gboolean ( *is_valid ) ( const NAObject *object );
}
diff --git a/src/core/na-data-boxed.c b/src/core/na-data-boxed.c
index 0448f00..6d8e935 100644
--- a/src/core/na-data-boxed.c
+++ b/src/core/na-data-boxed.c
@@ -41,42 +41,6 @@
#include <api/na-data-types.h>
#include <api/na-data-boxed.h>
-/**
- * SECTION: data-boxed
- * @title: NADataBoxed
- * @short_description: The Data Factory Element Class Definition
- * @include: nautilus-actions/na-data-boxed.h
- *
- * The object which encapsulates an elementary data of #NAIFactoryObject.
- * A #NADataBoxed object has a type and a value.
- *
- * <refsect2>
- * <title>Versions historic</title>
- * <table>
- * <title>Historic of the versions of the #NADataBoxed interface</title>
- * <tgroup rowsep="1" colsep="1" align="center" cols="3">
- * <colspec colname="na-version" />
- * <colspec colname="api-version" />
- * <colspec colname="current" />
- * <thead>
- * <row>
- * <entry>&prodname; version</entry>
- * <entry>#NADataBoxed interface version</entry>
- * <entry></entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>since 2.30</entry>
- * <entry>1</entry>
- * <entry>current version</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </table>
- * </refsect2>
- */
-
/* private class data
*/
struct NADataBoxedClassPrivate {
diff --git a/src/core/na-data-def.c b/src/core/na-data-def.c
index eb95ebc..706848b 100644
--- a/src/core/na-data-def.c
+++ b/src/core/na-data-def.c
@@ -37,17 +37,6 @@
#include <api/na-data-def.h>
/**
- * SECTION: data-def
- * @title: NADataDef, NADataGroup
- * @short_description: The Data Factory Structure Definitions
- * @include: nautilus-actions/na-data-def.h
- *
- * #NADataDef and #NADataGroup are structures which handle the list of
- * elementary datas for each and every #NAObjectItem which happens to
- * implement the #NAIFactoryObject interface.
- */
-
-/**
* na_data_def_get_data_def:
* @group: a #NADataGroup structure array.
* @group_name: the searched group name.
diff --git a/src/core/na-data-types.c b/src/core/na-data-types.c
index 1b10b36..2d03d95 100644
--- a/src/core/na-data-types.c
+++ b/src/core/na-data-types.c
@@ -34,13 +34,6 @@
#include <api/na-data-types.h>
-/**
- * SECTION: data-type
- * @title: NADataType
- * @short_description: The Data Factory Type Definitions
- * @include: nautilus-actions/na-data-types.h
- */
-
typedef struct {
guint type;
gchar *gconf_dump_key;
diff --git a/src/core/na-export-format.c b/src/core/na-export-format.c
index e998d6e..dbaca93 100644
--- a/src/core/na-export-format.c
+++ b/src/core/na-export-format.c
@@ -36,13 +36,13 @@
/* private class data
*/
-struct NAExportFormatClassPrivate {
+struct _NAExportFormatClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NAExportFormatPrivate {
+struct _NAExportFormatPrivate {
gboolean dispose_has_run;
GQuark id;
NAIExporterFormat *str;
@@ -170,7 +170,7 @@ instance_finalize( GObject *object )
}
}
-/**
+/*
* na_export_format_new:
* @exporter_format: a #NAIExporterFormat which describes an export format.
* @exporter: the #NAIExporter which provides this export format.
@@ -191,7 +191,7 @@ na_export_format_new( const NAIExporterFormat *exporter_format, const NAIExporte
return( format );
}
-/**
+/*
* na_export_format_get_quark:
* @format: this #NAExportFormat object.
*
@@ -214,7 +214,7 @@ na_export_format_get_quark( const NAExportFormat *format )
return( id );
}
-/**
+/*
* na_export_format_get_id:
* @format: this #NAExportFormat object.
*
@@ -238,7 +238,7 @@ na_export_format_get_id( const NAExportFormat *format )
return( id );
}
-/**
+/*
* na_export_format_get_label:
* @format: this #NAExportFormat object.
*
@@ -262,7 +262,7 @@ na_export_format_get_label( const NAExportFormat *format )
return( label );
}
-/**
+/*
* na_export_format_get_description:
* @format: this #NAExportFormat object.
*
@@ -286,7 +286,7 @@ na_export_format_get_description( const NAExportFormat *format )
return( description );
}
-/**
+/*
* na_export_format_get_exporter:
* @format: this #NAExportFormat object.
*
diff --git a/src/core/na-export-format.h b/src/core/na-export-format.h
index 55f267c..349ffac 100644
--- a/src/core/na-export-format.h
+++ b/src/core/na-export-format.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_EXPORT_FORMAT_H__
#define __CORE_NA_EXPORT_FORMAT_H__
-/**
- * SECTION: na_export_format
- * @short_description: #NAExportFormat class definition.
+/* @title: NAExportFormat
+ * @short_description: The #NAExportFormat Class Definition
* @include: core/na-export-format.h
*/
@@ -41,14 +40,14 @@
G_BEGIN_DECLS
-#define NA_EXPORT_FORMAT_TYPE ( na_export_format_get_type())
-#define NA_EXPORT_FORMAT( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_EXPORT_FORMAT_TYPE, NAExportFormat ))
-#define NA_EXPORT_FORMAT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_EXPORT_FORMAT_TYPE, NAExportFormatClass ))
-#define NA_IS_EXPORT_FORMAT( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_EXPORT_FORMAT_TYPE ))
-#define NA_IS_EXPORT_FORMAT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_EXPORT_FORMAT_TYPE ))
-#define NA_EXPORT_FORMAT_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_EXPORT_FORMAT_TYPE, NAExportFormatClass ))
+#define NA_EXPORT_FORMAT_TYPE ( na_export_format_get_type())
+#define NA_EXPORT_FORMAT( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_EXPORT_FORMAT_TYPE, NAExportFormat ))
+#define NA_EXPORT_FORMAT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_EXPORT_FORMAT_TYPE, NAExportFormatClass ))
+#define NA_IS_EXPORT_FORMAT( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_EXPORT_FORMAT_TYPE ))
+#define NA_IS_EXPORT_FORMAT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_EXPORT_FORMAT_TYPE ))
+#define NA_EXPORT_FORMAT_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_EXPORT_FORMAT_TYPE, NAExportFormatClass ))
-typedef struct NAExportFormatPrivate NAExportFormatPrivate;
+typedef struct _NAExportFormatPrivate NAExportFormatPrivate;
typedef struct {
GObject parent;
@@ -56,7 +55,7 @@ typedef struct {
}
NAExportFormat;
-typedef struct NAExportFormatClassPrivate NAExportFormatClassPrivate;
+typedef struct _NAExportFormatClassPrivate NAExportFormatClassPrivate;
typedef struct {
GObjectClass parent;
diff --git a/src/core/na-exporter.h b/src/core/na-exporter.h
index 6c10297..bd433ad 100644
--- a/src/core/na-exporter.h
+++ b/src/core/na-exporter.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_EXPORTER_H__
#define __CORE_NA_EXPORTER_H__
-/*
- * SECTION: na_iexporter
- * @short_description: #NAIExporter internal functions.
+/* @title: NAIExporter
+ * @short_description: The #NAIExporter Internal Functions
* @include: core/na-exporter.h
*/
diff --git a/src/core/na-factory-object.h b/src/core/na-factory-object.h
index 7a367ff..877efb3 100644
--- a/src/core/na-factory-object.h
+++ b/src/core/na-factory-object.h
@@ -31,8 +31,8 @@
#ifndef __CORE_NA_FACTORY_OBJECT_H__
#define __CORE_NA_FACTORY_OBJECT_H__
-/*
- * @short_description: #NAIFactoryObject internal functions.
+/* @title: NAIFactoryObject
+ * @short_description: The #NAIFactoryObject Internal Functions
* @include: core/na-factory-object.h
*
* Declare the function only accessed from core library, i.e. not
diff --git a/src/core/na-factory-provider.c b/src/core/na-factory-provider.c
index cf543f4..b5995b9 100644
--- a/src/core/na-factory-provider.c
+++ b/src/core/na-factory-provider.c
@@ -39,7 +39,7 @@
extern gboolean ifactory_provider_initialized; /* defined in na-ifactory-provider.c */
extern gboolean ifactory_provider_finalized;
-/**
+/*
* na_factory_provider_read_data:
* @reader: the instance which implements this #NAIFactoryProvider interface.
* @reader_data: instance data.
@@ -75,7 +75,7 @@ na_factory_provider_read_data( const NAIFactoryProvider *reader, void *reader_da
return( boxed );
}
-/**
+/*
* na_factory_provider_write_data:
* @writer: the instance which implements this #NAIFactoryProvider interface.
* @writer_data: instance data.
diff --git a/src/core/na-factory-provider.h b/src/core/na-factory-provider.h
index 3b984c3..f69ae7c 100644
--- a/src/core/na-factory-provider.h
+++ b/src/core/na-factory-provider.h
@@ -31,8 +31,8 @@
#ifndef __CORE_NA_FACTORY_PROVIDER_H__
#define __CORE_NA_FACTORY_PROVIDER_H__
-/*
- * SECTION: ifactory_provider
+/* @title: NAIFactoryProvider
+ * @short_description: The #NAIFactoryProvider Internal Functions
* @include: core/na-factory-provider.h
*
* Declare the function only accessed from core library (not published as API).
diff --git a/src/core/na-gnome-vfs-uri.c b/src/core/na-gnome-vfs-uri.c
index 2fb885d..070b053 100644
--- a/src/core/na-gnome-vfs-uri.c
+++ b/src/core/na-gnome-vfs-uri.c
@@ -320,7 +320,7 @@ gnome_vfs_canonicalize_pathname (gchar *path)
static const gchar hex[16] = "0123456789ABCDEF";
-/**
+/*
* gnome_vfs_escape_set:
* @string: string to be escaped.
* @match_set: a string containing all characters to be escaped in @string.
@@ -385,7 +385,7 @@ gnome_vfs_escape_set (const char *string,
return result;
}
-/**
+/*
* gnome_vfs_remove_optional_escapes:
* @uri: an escaped uri.
*
@@ -518,7 +518,7 @@ unescape_character (const char *scanner)
return (first_digit << 4) | second_digit;
}
-/**
+/*
* gnome_vfs_unescape_string:
* @escaped_string: an escaped uri, path, or other string.
* @illegal_characters: a string containing a sequence of characters
diff --git a/src/core/na-gnome-vfs-uri.h b/src/core/na-gnome-vfs-uri.h
index 84a1f3e..9dfa247 100644
--- a/src/core/na-gnome-vfs-uri.h
+++ b/src/core/na-gnome-vfs-uri.h
@@ -71,13 +71,13 @@ typedef struct {
}
NAGnomeVFSURI;
-/**
+/*
* GNOME_VFS_URI_MAGIC_CHR:
*
* The character used to divide location from
* extra "arguments" passed to the method.
**/
-/**
+/*
* GNOME_VFS_URI_MAGIC_STR:
*
* The character used to divide location from
@@ -86,12 +86,12 @@ typedef struct {
#define GNOME_VFS_URI_MAGIC_CHR '#'
#define GNOME_VFS_URI_MAGIC_STR "#"
-/**
+/*
* GNOME_VFS_URI_PATH_CHR:
*
* Defines the path seperator character.
**/
-/**
+/*
* GNOME_VFS_URI_PATH_STR:
*
* Defines the path seperator string.
diff --git a/src/core/na-gtk-utils.c b/src/core/na-gtk-utils.c
index 6c9d684..82befd6 100644
--- a/src/core/na-gtk-utils.c
+++ b/src/core/na-gtk-utils.c
@@ -36,7 +36,7 @@
#include "na-gtk-utils.h"
-/**
+/*
* na_gtk_utils_search_for_child_widget:
* @container: a #GtkContainer, usually the #GtkWindow toplevel.
* @name: the name of the searched widget.
diff --git a/src/core/na-gtk-utils.h b/src/core/na-gtk-utils.h
index a985d8c..f25be32 100644
--- a/src/core/na-gtk-utils.h
+++ b/src/core/na-gtk-utils.h
@@ -31,9 +31,8 @@
#ifndef __CORE_API_NA_GTK_UTILS_H__
#define __CORE_API_NA_GTK_UTILS_H__
-/**
- * SECTION: na_core_utils
- * @short_description: Core library utilities.
+/* @title: GTK+
+ * @short_description: The Gtk+ Library Utilities.
* @include: nautilus-action/na-core-utils.h
*/
diff --git a/src/core/na-iabout.c b/src/core/na-iabout.c
index e300545..fb414ea 100644
--- a/src/core/na-iabout.c
+++ b/src/core/na-iabout.c
@@ -38,7 +38,7 @@
/* private interface data
*/
-struct NAIAboutInterfacePrivate {
+struct _NAIAboutInterfacePrivate {
void *empty; /* so that gcc -pedantic is happy */
};
@@ -141,7 +141,7 @@ v_get_toplevel( NAIAbout *instance )
return( NULL );
}
-/**
+/*
* na_iabout_display:
* @instance: the #NAIAbout implementor.
*
@@ -222,7 +222,7 @@ na_iabout_display( NAIAbout *instance )
}
}
-/**
+/*
* na_iabout_get_icon_name:
*
* Returns: the name of the default icon for the application, as a newly
@@ -234,7 +234,7 @@ na_iabout_get_icon_name( void )
return( g_strdup( PACKAGE ));
}
-/**
+/*
* na_iabout_get_copyright:
* @console: whether the string is to be printed on a console.
*
diff --git a/src/core/na-iabout.h b/src/core/na-iabout.h
index 25df82c..4cecdb6 100644
--- a/src/core/na-iabout.h
+++ b/src/core/na-iabout.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_IABOUT_H__
#define __CORE_NA_IABOUT_H__
-/**
- * SECTION: na_iabout
- * @short_description: NAIAbout interface definition.
+/* @title NAIAbout
+ * @short_description: The #NAIAbout Interface Definition
* @include: runtime/na-iabout.h
*
* This interface displays the 'About Nautilus Actions' dialog box.
@@ -45,19 +44,21 @@
G_BEGIN_DECLS
-#define NA_IABOUT_TYPE ( na_iabout_get_type())
-#define NA_IABOUT( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IABOUT_TYPE, NAIAbout ))
-#define NA_IS_IABOUT( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IABOUT_TYPE ))
-#define NA_IABOUT_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IABOUT_TYPE, NAIAboutInterface ))
+#define NA_IABOUT_TYPE ( na_iabout_get_type())
+#define NA_IABOUT( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IABOUT_TYPE, NAIAbout ))
+#define NA_IS_IABOUT( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IABOUT_TYPE ))
+#define NA_IABOUT_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IABOUT_TYPE, NAIAboutInterface ))
-typedef struct NAIAbout NAIAbout;
+typedef struct _NAIAbout NAIAbout;
-typedef struct NAIAboutInterfacePrivate NAIAboutInterfacePrivate;
+typedef struct _NAIAboutInterfacePrivate NAIAboutInterfacePrivate;
typedef struct {
+ /*< private >*/
GTypeInterface parent;
NAIAboutInterfacePrivate *private;
+ /*< public >*/
/**
* get_application_name:
* @iabout: this #NAIAbout implementor.
diff --git a/src/core/na-iexporter.c b/src/core/na-iexporter.c
index 686d993..fcb73a5 100644
--- a/src/core/na-iexporter.c
+++ b/src/core/na-iexporter.c
@@ -34,41 +34,6 @@
#include <api/na-iexporter.h>
-/**
- * SECTION: iexporter
- * @title: NAIExporter
- * @short_description: The Export Interface v 1
- * @include: nautilus-actions/na-iexporter.h
- *
- * The #NAIExporter interface exports items to the outside world.
- *
- * <refsect2>
- * <title>Versions historic</title>
- * <table>
- * <title>Historic of the versions of the #NAIExporter interface</title>
- * <tgroup rowsep="1" colsep="1" align="center" cols="3">
- * <colspec colname="na-version" />
- * <colspec colname="api-version" />
- * <colspec colname="current" />
- * <thead>
- * <row>
- * <entry>&prodname; version</entry>
- * <entry>#NAIExporter interface version</entry>
- * <entry></entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>since 2.30</entry>
- * <entry>1</entry>
- * <entry>current version</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </table>
- * </refsect2>
- */
-
/* private interface data
*/
struct _NAIExporterInterfacePrivate {
diff --git a/src/core/na-ifactory-object.c b/src/core/na-ifactory-object.c
index 16545be..2f95cce 100644
--- a/src/core/na-ifactory-object.c
+++ b/src/core/na-ifactory-object.c
@@ -38,52 +38,6 @@
#include "na-factory-object.h"
-/**
- * SECTION: ifactory-object
- * @title: NAIFactoryObject
- * @short_description: The #NAObjectItem Interface v 1
- * @include: nautilus-actions/na-ifactory_object.h
- *
- * This interface is implemented by #NAObjectItem derived objects so that they
- * can take advantage of our data factory management system.
- *
- * A #NAObjectItem derived object which would implement this #NAIFactoryObject
- * interface must meet following conditions:
- * <itemizedlist>
- * <listitem>
- * <para>
- * accept an empty constructor
- * </para>
- * </listitem>
- * </itemizedlist>
- *
- * <refsect2>
- * <title>Versions historic</title>
- * <table>
- * <title>Historic of the versions of the #NAIFactoryObject interface</title>
- * <tgroup rowsep="1" colsep="1" align="center" cols="3">
- * <colspec colname="na-version" />
- * <colspec colname="api-version" />
- * <colspec colname="current" />
- * <thead>
- * <row>
- * <entry>&prodname; version</entry>
- * <entry>#NAIFactoryObject interface version</entry>
- * <entry></entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>since 2.30</entry>
- * <entry>1</entry>
- * <entry>current version</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </table>
- * </refsect2>
- */
-
/* private interface data
*/
struct _NAIFactoryObjectInterfacePrivate {
diff --git a/src/core/na-ifactory-provider.c b/src/core/na-ifactory-provider.c
index 74a6193..aa0fbe5 100644
--- a/src/core/na-ifactory-provider.c
+++ b/src/core/na-ifactory-provider.c
@@ -38,110 +38,6 @@
#include "na-factory-object.h"
#include "na-factory-provider.h"
-/**
- * SECTION: ifactory-provider
- * @title: NAIFactoryProvider
- * @short_description: The Data Factory Provider Interface v 1
- * @include: nautilus-actions/na-ifactory_provider.h
- *
- * &prodname; has to deal with a relatively great number of elementary datas,
- * reading them from different supports, storing and displaying them,
- * then re-writing these same datas, with several output formats, and so on.
- *
- * This has rapidly become a pain, if not just a bug generator.
- * Each new data must be described, have a schema to be stored in
- * (historical storage subsystem) GConf; import and export assistants
- * must be carefully updated to export the new data...
- *
- * The #NAIFactoryProvider aims to simplify and organize all the work
- * which must be done around each and every elementary data. It is based
- * on three main things:
- *
- * <orderedlist>
- * <listitem>
- * <formalpara>
- * <title>Elementary datas are banalized.</title>
- * <para>
- * whether they are a string, an integer, a boolean, a simple
- * or double-linked list, each elementary data is encapsuled
- * into a #NADataBoxed, small sort of structure (incidentally,
- * which acts almost as the new GLib #GVariant, but too late,
- * guys :)).
- * </para>
- * </formalpara>
- * </listitem>
- * <listitem>
- * <formalpara>
- * <title>Our objects are de-structured.</title>
- * <para>
- * Instead of organizing our elementary datas into structures,
- * our objects are just flat lists of #NADataBoxed.
- * </para>
- * </formalpara>
- * </listitem>
- * <listitem>
- * <formalpara>
- * <title>A full, centralized, data dictionary is defined.</title>
- * <para>
- * Now that our elementary datas are banalized and de-structured,
- * it is simple enough to describe each of these datas with all
- * iss properties in one single, centralized, place.
- * </para>
- * </formalpara>
- * </listitem>
- * </orderedlist>
- *
- * Of course, I/O providers are good candidates to be users of this
- * #NAIFactoryProvider interface.
- *
- * Without this interface, each and every I/O provider must,
- * for example when reading an item, have the list of data to be
- * readen for each item, then read each individual data, then
- * organize them in a I/O structure..
- * Each time a new data is added to an object, as e.g. a new condition,
- * then all available I/O providers must be updated: read the data,
- * write the data, then display the data, and so on..
- *
- * With this #NAIFactoryProvider interface, the I/O provider has just to
- * deal with reading/writing elementary types. It does need to know that
- * it will have to read, name, tooltip, description. It just needs to know
- * how to read a string.
- * And while we do not introduce another data type, the I/O provider
- * does not need any maintenance even if we add lot of new data, conditions
- * labels, and so on.
- *
- * So, this is the interface used by data factory management system for
- * providing serialization/unserialization services. This interface may
- * be implemented by I/O providers which would take advantage of this
- * system.
- *
- * <refsect2>
- * <title>Versions historic</title>
- * <table>
- * <title>Historic of the versions of the #NAIFactoryProvider interface</title>
- * <tgroup rowsep="1" colsep="1" align="center" cols="3">
- * <colspec colname="na-version" />
- * <colspec colname="api-version" />
- * <colspec colname="current" />
- * <thead>
- * <row>
- * <entry>&prodname; version</entry>
- * <entry>#NAIFactoryProvider interface version</entry>
- * <entry></entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>since 2.30</entry>
- * <entry>1</entry>
- * <entry>current version</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </table>
- * </refsect2>
- */
-
/* private interface data
*/
struct _NAIFactoryProviderInterfacePrivate {
diff --git a/src/core/na-iimporter.c b/src/core/na-iimporter.c
index 0204fe5..1ba7d79 100644
--- a/src/core/na-iimporter.c
+++ b/src/core/na-iimporter.c
@@ -38,41 +38,6 @@
#include <api/na-iimporter.h>
#include <api/na-object-api.h>
-/**
- * SECTION: iimporter
- * @title: NAIImporter
- * @short_description: The Import Interface v 1
- * @include: nautilus-actions/na-iimporter.h
- *
- * The #NAIImporter interface imports items from the outside world.
- *
- * <refsect2>
- * <title>Versions historic</title>
- * <table>
- * <title>Historic of the versions of the #NAIImporter interface</title>
- * <tgroup rowsep="1" colsep="1" align="center" cols="3">
- * <colspec colname="na-version" />
- * <colspec colname="api-version" />
- * <colspec colname="current" />
- * <thead>
- * <row>
- * <entry>&prodname; version</entry>
- * <entry>#NAIImporter interface version</entry>
- * <entry></entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>since 2.30</entry>
- * <entry>1</entry>
- * <entry>current version</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </table>
- * </refsect2>
- */
-
/* private interface data
*/
struct _NAIImporterInterfacePrivate {
diff --git a/src/core/na-iio-provider.c b/src/core/na-iio-provider.c
index c425f0d..ca7efee 100644
--- a/src/core/na-iio-provider.c
+++ b/src/core/na-iio-provider.c
@@ -34,68 +34,6 @@
#include <api/na-iio-provider.h>
-/**
- * SECTION: iio-provider
- * @title: NAIIOProvider
- * @short_description: The I/O Provider Interface v 1
- * @include: nautilus-actions/na-iio-provider.h
- *
- * The #NAIIOProvider interface is defined in order to let internal
- * and external plugins provide read and write accesses
- * to an alternate storage subsystem.
- *
- * The #NAIIOProvider interface provides three types of services:
- * <itemizedlist>
- * <listitem>
- * <para>
- * load all items at startup;
- * </para>
- * </listitem>
- * <listitem>
- * <para>
- * create, update or delete items via the management user interface;
- * </para>
- * </listitem>
- * <listitem>
- * <para>
- * inform &prodname; when an item has been modified on the
- * underlying storage subsystem.
- * </para>
- * </listitem>
- * </itemizedlist>
- *
- * These services may be fully implemented by the I/O provider itself.
- * Or, the I/O provider may also prefer to take advantage of the data
- * factory management (see #NAIFactoryObject and #NAIFactoryProvider
- * interfaces).
- *
- * <refsect2>
- * <title>Versions historic</title>
- * <table>
- * <title>Historic of the versions of the #NAIIOProvider interface</title>
- * <tgroup rowsep="1" colsep="1" align="center" cols="3">
- * <colspec colname="na-version" />
- * <colspec colname="api-version" />
- * <colspec colname="current" />
- * <thead>
- * <row>
- * <entry>&prodname; version</entry>
- * <entry>#NAIIOProvider interface version</entry>
- * <entry></entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>since 2.30</entry>
- * <entry>1</entry>
- * <entry>current version</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </table>
- * </refsect2>
- */
-
/* private interface data
*/
struct _NAIIOProviderInterfacePrivate {
diff --git a/src/core/na-importer-ask.c b/src/core/na-importer-ask.c
index 333fa0d..e92bc44 100644
--- a/src/core/na-importer-ask.c
+++ b/src/core/na-importer-ask.c
@@ -46,13 +46,13 @@
/* private class data
*/
-struct NAImporterAskClassPrivate {
+struct _NAImporterAskClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NAImporterAskPrivate {
+struct _NAImporterAskPrivate {
gboolean dispose_has_run;
GtkBuilder *builder;
GtkWindow *toplevel;
diff --git a/src/core/na-importer-ask.h b/src/core/na-importer-ask.h
index ab08593..f5128b2 100644
--- a/src/core/na-importer-ask.h
+++ b/src/core/na-importer-ask.h
@@ -31,10 +31,8 @@
#ifndef __CORE_NA_IMPORTER_ASK_H__
#define __CORE_NA_IMPORTER_ASK_H__
-/*
- * SECTION: importer-ask
- * @title: NAImporterAsk
- * @short_description: The #NAImporterAsk class definition.
+/* @title: NAImporterAsk
+ * @short_description: The #NAImporterAsk Class Definition
* @include: core/na-iimporter-ask.h
*
* This class reates and manages a dialog. It is ran each time an
@@ -48,24 +46,26 @@
G_BEGIN_DECLS
-#define NA_IMPORTER_ASK_TYPE ( na_importer_ask_get_type())
-#define NA_IMPORTER_ASK( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IMPORTER_ASK_TYPE, NAImporterAsk ))
-#define NA_IMPORTER_ASK_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_IMPORTER_ASK_TYPE, NAImporterAskClass ))
-#define NA_IS_IMPORTER_ASK( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IMPORTER_ASK_TYPE ))
-#define NA_IS_IMPORTER_ASK_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_IMPORTER_ASK_TYPE ))
-#define NA_IMPORTER_ASK_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_IMPORTER_ASK_TYPE, NAImporterAskClass ))
+#define NA_IMPORTER_ASK_TYPE ( na_importer_ask_get_type())
+#define NA_IMPORTER_ASK( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IMPORTER_ASK_TYPE, NAImporterAsk ))
+#define NA_IMPORTER_ASK_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_IMPORTER_ASK_TYPE, NAImporterAskClass ))
+#define NA_IS_IMPORTER_ASK( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IMPORTER_ASK_TYPE ))
+#define NA_IS_IMPORTER_ASK_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_IMPORTER_ASK_TYPE ))
+#define NA_IMPORTER_ASK_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_IMPORTER_ASK_TYPE, NAImporterAskClass ))
-typedef struct NAImporterAskPrivate NAImporterAskPrivate;
+typedef struct _NAImporterAskPrivate NAImporterAskPrivate;
typedef struct {
+ /*< private >*/
GtkDialog parent;
NAImporterAskPrivate *private;
}
NAImporterAsk;
-typedef struct NAImporterAskClassPrivate NAImporterAskClassPrivate;
+typedef struct _NAImporterAskClassPrivate NAImporterAskClassPrivate;
typedef struct {
+ /*< private >*/
GtkDialogClass parent;
NAImporterAskClassPrivate *private;
}
diff --git a/src/core/na-importer.h b/src/core/na-importer.h
index d432590..289db62 100644
--- a/src/core/na-importer.h
+++ b/src/core/na-importer.h
@@ -31,10 +31,8 @@
#ifndef __CORE_NA_IMPORTER_H__
#define __CORE_NA_IMPORTER_H__
-/*
- * SECTION: iimporter
- * @title: NAIImporter
- * @short_description: The NAIImporter internal functions.
+/* @title: NAIImporter
+ * @short_description: The #NAIImporter Internal Functions
* @include: core/na-importer.h
*
* Internal Nautilus-Actions code should never directly call a
diff --git a/src/core/na-io-provider.c b/src/core/na-io-provider.c
index 857b077..fc02a5c 100644
--- a/src/core/na-io-provider.c
+++ b/src/core/na-io-provider.c
@@ -44,13 +44,13 @@
/* private class data
*/
-struct NAIOProviderClassPrivate {
+struct _NAIOProviderClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NAIOProviderPrivate {
+struct _NAIOProviderPrivate {
gboolean dispose_has_run;
gchar *id;
gchar *name;
diff --git a/src/core/na-io-provider.h b/src/core/na-io-provider.h
index e7cbf4a..f6074e3 100644
--- a/src/core/na-io-provider.h
+++ b/src/core/na-io-provider.h
@@ -31,10 +31,8 @@
#ifndef __CORE_NA_IO_PROVIDER_H__
#define __CORE_NA_IO_PROVIDER_H__
-/*
- * SECTION: io-provider
- * @title: NAIIOProvider internals.
- * @short_description: #NAIOProvider class definition.
+/* @title: NAIIOProvider
+ * @short_description: The #NAIOProvider Class Definition.
* @include: core/na-io-provider.h
*
* NAIOProvider is the Nautilus-Actions class which is used to manage
@@ -50,24 +48,26 @@
G_BEGIN_DECLS
-#define NA_IO_PROVIDER_TYPE ( na_io_provider_get_type())
-#define NA_IO_PROVIDER( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IO_PROVIDER_TYPE, NAIOProvider ))
-#define NA_IO_PROVIDER_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_IO_PROVIDER_TYPE, NAIOProviderClass ))
-#define NA_IS_IO_PROVIDER( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IO_PROVIDER_TYPE ))
-#define NA_IS_IO_PROVIDER_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_IO_PROVIDER_TYPE ))
-#define NA_IO_PROVIDER_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_IO_PROVIDER_TYPE, NAIOProviderClass ))
+#define NA_IO_PROVIDER_TYPE ( na_io_provider_get_type())
+#define NA_IO_PROVIDER( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IO_PROVIDER_TYPE, NAIOProvider ))
+#define NA_IO_PROVIDER_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_IO_PROVIDER_TYPE, NAIOProviderClass ))
+#define NA_IS_IO_PROVIDER( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IO_PROVIDER_TYPE ))
+#define NA_IS_IO_PROVIDER_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_IO_PROVIDER_TYPE ))
+#define NA_IO_PROVIDER_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_IO_PROVIDER_TYPE, NAIOProviderClass ))
-typedef struct NAIOProviderPrivate NAIOProviderPrivate;
+typedef struct _NAIOProviderPrivate NAIOProviderPrivate;
typedef struct {
+ /*< private >*/
GObject parent;
NAIOProviderPrivate *private;
}
NAIOProvider;
-typedef struct NAIOProviderClassPrivate NAIOProviderClassPrivate;
+typedef struct _NAIOProviderClassPrivate NAIOProviderClassPrivate;
typedef struct {
+ /*< private >*/
GObjectClass parent;
NAIOProviderClassPrivate *private;
}
diff --git a/src/core/na-ipivot-consumer.c b/src/core/na-ipivot-consumer.c
index fe93e05..8a70f14 100644
--- a/src/core/na-ipivot-consumer.c
+++ b/src/core/na-ipivot-consumer.c
@@ -38,7 +38,7 @@
/* private interface data
*/
-struct NAIPivotConsumerInterfacePrivate {
+struct _NAIPivotConsumerInterfacePrivate {
void *empty; /* so that gcc -pedantic is happy */
};
@@ -51,7 +51,7 @@ static void interface_base_finalize( NAIPivotConsumerInterface *klass );
static gboolean is_notify_allowed( const NAIPivotConsumer *instance );
-/**
+/*
* Registers the GType of this interface.
*/
GType
@@ -127,7 +127,7 @@ interface_base_finalize( NAIPivotConsumerInterface *klass )
}
}
-/**
+/*
* na_ipivot_consumer_allow_notify:
* @instance: the #NAIPivotConsumer instance.
* @allow: whether notifications are allowed for this consumer.
@@ -173,7 +173,7 @@ na_ipivot_consumer_allow_notify( NAIPivotConsumer *instance, gboolean allow, gui
}
}
-/**
+/*
* na_ipivot_consumer_notify_of_autosave_changed:
* @instance: the #NAIPivotConsumer instance to be notified of the end
* of the modifications.
@@ -198,7 +198,7 @@ na_ipivot_consumer_notify_of_autosave_changed( NAIPivotConsumer *instance, gbool
}
}
-/**
+/*
* na_ipivot_consumer_notify_of_create_root_menu_changed:
* @instance: the #NAIPivotConsumer instance to be notified of the end
* of the modifications.
@@ -222,7 +222,7 @@ na_ipivot_consumer_notify_of_create_root_menu_changed( NAIPivotConsumer *instanc
}
}
-/**
+/*
* na_ipivot_consumer_notify_of_display_about_changed:
* @instance: the #NAIPivotConsumer instance to be notified of the end
* of the modifications.
@@ -247,7 +247,7 @@ na_ipivot_consumer_notify_of_display_about_changed( NAIPivotConsumer *instance,
}
}
-/**
+/*
* na_ipivot_consumer_notify_of_display_order_changed:
* @instance: the #NAIPivotConsumer instance to be notified of the end
* of the modifications.
@@ -271,7 +271,7 @@ na_ipivot_consumer_notify_of_display_order_changed( NAIPivotConsumer *instance,
}
}
-/**
+/*
* na_ipivot_consumer_notify_of_io_provider_prefs_changed:
* @instance: the #NAIPivotConsumer instance to be notified of the modifications.
*
@@ -296,7 +296,7 @@ void na_ipivot_consumer_notify_of_io_provider_prefs_changed( NAIPivotConsumer *i
}
}
-/**
+/*
* na_ipivot_consumer_notify_of_items_changed:
* @instance: the #NAIPivotConsumer instance to be notified of the end
* of the modifications.
@@ -323,7 +323,7 @@ void na_ipivot_consumer_notify_of_items_changed( NAIPivotConsumer *instance )
}
}
-/**
+/*
* na_ipivot_consumer_notify_of_mandatory_prefs_changed:
* @instance: the #NAIPivotConsumer instance to be notified of the modifications.
*
diff --git a/src/core/na-ipivot-consumer.h b/src/core/na-ipivot-consumer.h
index a1a9bc3..0bf1d6d 100644
--- a/src/core/na-ipivot-consumer.h
+++ b/src/core/na-ipivot-consumer.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_IPIVOT_CONSUMER_H__
#define __CORE_NA_IPIVOT_CONSUMER_H__
-/**
- * SECTION: na_ipivot_consumer
- * @short_description: #NAIPivotConsumer interface definition.
+/* @title: NAIPivotConsumer
+ * @short_description: The #NAIPivotConsumer Interface Definition
* @include: runtime/na-ipivot-consumer.h
*
* This interface should be implemented by all classes which embed a
@@ -45,20 +44,22 @@
G_BEGIN_DECLS
-#define NA_IPIVOT_CONSUMER_TYPE ( na_ipivot_consumer_get_type())
-#define NA_IPIVOT_CONSUMER( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IPIVOT_CONSUMER_TYPE, NAIPivotConsumer ))
-#define NA_IS_IPIVOT_CONSUMER( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IPIVOT_CONSUMER_TYPE ))
-#define NA_IPIVOT_CONSUMER_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IPIVOT_CONSUMER_TYPE, NAIPivotConsumerInterface ))
+#define NA_IPIVOT_CONSUMER_TYPE ( na_ipivot_consumer_get_type())
+#define NA_IPIVOT_CONSUMER( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IPIVOT_CONSUMER_TYPE, NAIPivotConsumer ))
+#define NA_IS_IPIVOT_CONSUMER( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IPIVOT_CONSUMER_TYPE ))
+#define NA_IPIVOT_CONSUMER_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IPIVOT_CONSUMER_TYPE, NAIPivotConsumerInterface ))
-typedef struct NAIPivotConsumer NAIPivotConsumer;
+typedef struct _NAIPivotConsumer NAIPivotConsumer;
-typedef struct NAIPivotConsumerInterfacePrivate NAIPivotConsumerInterfacePrivate;
+typedef struct _NAIPivotConsumerInterfacePrivate NAIPivotConsumerInterfacePrivate;
typedef struct {
+ /*< private >*/
GTypeInterface parent;
NAIPivotConsumerInterfacePrivate *private;
- /**
+ /*< public >*/
+ /*
* on_autosave_changed:
* @instance: the #NAIPivotConsumer instance which implements this
* interface.
@@ -71,7 +72,7 @@ typedef struct {
*/
void ( *on_autosave_changed ) ( NAIPivotConsumer *instance, gboolean enabled, guint period );
- /**
+ /*
* on_create_root_menu_changed:
* @instance: the #NAIPivotConsumer instance which implements this
* interface.
@@ -82,7 +83,7 @@ typedef struct {
*/
void ( *on_create_root_menu_changed ) ( NAIPivotConsumer *instance, gboolean enabled );
- /**
+ /*
* on_display_about_changed:
* @instance: the #NAIPivotConsumer instance which implements this
* interface.
@@ -93,7 +94,7 @@ typedef struct {
*/
void ( *on_display_about_changed ) ( NAIPivotConsumer *instance, gboolean enabled );
- /**
+ /*
* on_display_order_changed:
* @instance: the #NAIPivotConsumer instance which implements this
* interface.
@@ -104,7 +105,7 @@ typedef struct {
*/
void ( *on_display_order_changed ) ( NAIPivotConsumer *instance, gint order_mode );
- /**
+ /*
* on_io_provider_prefs_changed:
* @instance: the #NAIPivotConsumer instance which implements this interface.
*
@@ -112,7 +113,7 @@ typedef struct {
*/
void ( *on_io_provider_prefs_changed )( NAIPivotConsumer *instance );
- /**
+ /*
* on_items_changed:
* @instance: the #NAIPivotConsumer instance which implements this
* interface.
@@ -125,7 +126,7 @@ typedef struct {
*/
void ( *on_items_changed ) ( NAIPivotConsumer *instance, gpointer user_data );
- /**
+ /*
* on_mandatory_prefs_changed:
* @instance: the #NAIPivotConsumer instance which implements this interface.
*
diff --git a/src/core/na-iprefs.c b/src/core/na-iprefs.c
index dbd6539..9de3770 100644
--- a/src/core/na-iprefs.c
+++ b/src/core/na-iprefs.c
@@ -39,7 +39,7 @@
/* private interface data
*/
-struct NAIPrefsInterfacePrivate {
+struct _NAIPrefsInterfacePrivate {
GConfClient *gconf;
};
@@ -146,7 +146,7 @@ interface_base_finalize( NAIPrefsInterface *klass )
}
}
-/**
+/*
* na_iprefs_get_order_mode:
* @instance: this #NAIPrefs interface instance.
*
@@ -184,7 +184,7 @@ na_iprefs_get_order_mode( NAIPrefs *instance )
return( alpha_order );
}
-/**
+/*
* na_iprefs_set_order_mode:
* @instance: this #NAIPrefs interface instance.
* @mode: the new value to be written.
@@ -210,7 +210,7 @@ na_iprefs_set_order_mode( NAIPrefs *instance, gint mode )
}
}
-/**
+/*
* na_iprefs_get_import_mode:
* @gconf: a #GCongClient client.
* @pref: name of the import key to be readen
@@ -249,7 +249,7 @@ na_iprefs_get_import_mode( GConfClient *gconf, const gchar *pref )
return( import_mode );
}
-/**
+/*
* na_iprefs_set_import_mode:
* @gconf: a #GCongClient client.
* @pref: name of the import key to be written
@@ -277,7 +277,7 @@ na_iprefs_set_import_mode( GConfClient *gconf, const gchar *pref, guint mode )
g_free( path );
}
-/**
+/*
* na_iprefs_get_gconf_client:
* @instance: this #NAIPrefs interface instance.
*
@@ -300,7 +300,7 @@ na_iprefs_get_gconf_client( const NAIPrefs *instance )
return( client );
}
-/**
+/*
* na_iprefs_read_bool:
* @instance: this #NAIPrefs interface instance.
* @key: the name of the preference entry.
@@ -329,7 +329,7 @@ na_iprefs_read_bool( const NAIPrefs *instance, const gchar *key, gboolean defaul
return( ret );
}
-/**
+/*
* na_iprefs_read_string:
* @instance: this #NAIPrefs interface instance.
* @key: the preference key.
@@ -359,7 +359,7 @@ na_iprefs_read_string( const NAIPrefs *instance, const gchar *key, const gchar *
return( value );
}
-/**
+/*
* na_iprefs_read_string_list:
* @instance: this #NAIPrefs interface instance.
* @key: the preference key.
@@ -394,7 +394,7 @@ na_iprefs_read_string_list( const NAIPrefs *instance, const gchar *key, const gc
return( list );
}
-/**
+/*
* na_iprefs_read_uint:
* @instance: this #NAIPrefs interface instance.
* @key: the preference entry.
@@ -445,7 +445,7 @@ write_string( NAIPrefs *instance, const gchar *name, const gchar *value )
}
}
-/**
+/*
* na_iprefs_write_string_list
* @instance: this #NAIPrefs interface instance.
* @key: the preference key.
diff --git a/src/core/na-iprefs.h b/src/core/na-iprefs.h
index 4732ca2..6e13c33 100644
--- a/src/core/na-iprefs.h
+++ b/src/core/na-iprefs.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_IPREFS_H__
#define __CORE_NA_IPREFS_H__
-/**
- * SECTION: na_iprefs
- * @short_description: #NAIPrefs interface definition.
+/* @title: NAIPrefs
+ * @short_description: The #NAIPrefs Interface Definition
* @include: core/na-iprefs.h
*
* This interface should only be implemented by #NAPivot. This is
@@ -72,16 +71,17 @@
G_BEGIN_DECLS
-#define NA_IPREFS_TYPE ( na_iprefs_get_type())
-#define NA_IPREFS( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IPREFS_TYPE, NAIPrefs ))
-#define NA_IS_IPREFS( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IPREFS_TYPE ))
-#define NA_IPREFS_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IPREFS_TYPE, NAIPrefsInterface ))
+#define NA_IPREFS_TYPE ( na_iprefs_get_type())
+#define NA_IPREFS( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_IPREFS_TYPE, NAIPrefs ))
+#define NA_IS_IPREFS( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_IPREFS_TYPE ))
+#define NA_IPREFS_GET_INTERFACE( instance ) ( G_TYPE_INSTANCE_GET_INTERFACE(( instance ), NA_IPREFS_TYPE, NAIPrefsInterface ))
-typedef struct NAIPrefs NAIPrefs;
+typedef struct _NAIPrefs NAIPrefs;
-typedef struct NAIPrefsInterfacePrivate NAIPrefsInterfacePrivate;
+typedef struct _NAIPrefsInterfacePrivate NAIPrefsInterfacePrivate;
typedef struct {
+ /*< private >*/
GTypeInterface parent;
NAIPrefsInterfacePrivate *private;
}
diff --git a/src/core/na-module.c b/src/core/na-module.c
index 1343c5e..5d4f6ff 100644
--- a/src/core/na-module.c
+++ b/src/core/na-module.c
@@ -40,13 +40,13 @@
/* private class data
*/
-struct NAModuleClassPrivate {
+struct _NAModuleClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NAModulePrivate {
+struct _NAModulePrivate {
gboolean dispose_has_run;
gchar *path; /* full pathname of the plugin */
gchar *name; /* basename without the extension */
@@ -198,7 +198,7 @@ instance_finalize( GObject *object )
}
}
-/**
+/*
* na_module_dump:
* @module: this #NAModule instance.
*
@@ -219,7 +219,7 @@ na_module_dump( const NAModule *module )
}
}
-/**
+/*
* na_module_load_modules:
*
* Load availables dynamically loadable extension libraries (plugins).
@@ -449,7 +449,7 @@ module_unload( GTypeModule *gmodule )
module->private->shutdown = NULL;
}
-/**
+/*
* na_module_get_extensions_for_type:
* @type: the serched GType.
*
@@ -475,7 +475,7 @@ na_module_get_extensions_for_type( GList *modules, GType type )
return( g_list_reverse( willing_to ));
}
-/**
+/*
* na_module_free_extensions_list:
* @extensions: a #GList as returned by #na_module_get_extensions_for_type().
*
@@ -488,7 +488,7 @@ na_module_free_extensions_list( GList *extensions )
g_list_free( extensions );
}
-/**
+/*
* na_module_has_id:
* @module: this #NAModule object.
* @id: the searched id.
@@ -510,7 +510,7 @@ na_module_has_id( NAModule *module, const gchar *id )
return( id_ok );
}
-/**
+/*
* na_module_release_modules:
* @modules: the list of loaded modules.
*
diff --git a/src/core/na-module.h b/src/core/na-module.h
index ee3f66d..060cb00 100644
--- a/src/core/na-module.h
+++ b/src/core/na-module.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_MODULE_H__
#define __CORE_NA_MODULE_H__
-/**
- * SECTION: na_module
- * @short_description: #NAModule class definition.
+/* @title: NAModule
+ * @short_description: The #NAModule Class Definition
* @include: core/na-module.h
*
* The NAModule class manages Nautilus-Actions extensions as dynamically
@@ -69,24 +68,26 @@
G_BEGIN_DECLS
-#define NA_MODULE_TYPE ( na_module_get_type())
-#define NA_MODULE( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_MODULE_TYPE, NAModule ))
-#define NA_MODULE_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_MODULE_TYPE, NAModuleClass ))
-#define NA_IS_MODULE( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_MODULE_TYPE ))
-#define NA_IS_MODULE_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_MODULE_TYPE ))
-#define NA_MODULE_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_MODULE_TYPE, NAModuleClass ))
+#define NA_MODULE_TYPE ( na_module_get_type())
+#define NA_MODULE( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_MODULE_TYPE, NAModule ))
+#define NA_MODULE_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_MODULE_TYPE, NAModuleClass ))
+#define NA_IS_MODULE( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_MODULE_TYPE ))
+#define NA_IS_MODULE_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_MODULE_TYPE ))
+#define NA_MODULE_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_MODULE_TYPE, NAModuleClass ))
-typedef struct NAModulePrivate NAModulePrivate;
+typedef struct _NAModulePrivate NAModulePrivate;
typedef struct {
+ /*< private >*/
GTypeModule parent;
NAModulePrivate *private;
}
NAModule;
-typedef struct NAModuleClassPrivate NAModuleClassPrivate;
+typedef struct _NAModuleClassPrivate NAModuleClassPrivate;
typedef struct {
+ /*< private >*/
GTypeModuleClass parent;
NAModuleClassPrivate *private;
}
diff --git a/src/core/na-object.c b/src/core/na-object.c
index ff7b9d5..c051d6b 100644
--- a/src/core/na-object.c
+++ b/src/core/na-object.c
@@ -38,13 +38,13 @@
/* private class data
*/
-struct NAObjectClassPrivate {
+struct _NAObjectClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NAObjectPrivate {
+struct _NAObjectPrivate {
gboolean dispose_has_run;
};
@@ -359,7 +359,7 @@ iduplicable_is_valid_iter( GObjectClass *class, const NAObject *a, HierarchyIter
/**
* na_object_object_check_status:
- * @object: the #NAObject-derived object to be checked.
+ * @object: the #NAObject -derived object to be checked.
*
* Recursively checks for the edition status of @object and its childs
* (if any).
@@ -370,12 +370,14 @@ iduplicable_is_valid_iter( GObjectClass *class, const NAObject *a, HierarchyIter
* na_object_object_check_status( object )
* +- na_iduplicable_check_status( object )
* +- get_origin( object )
- * +- modified_status = v_are_equal( origin, object ) -> interface are_equal()
- * +- valid_status = v_is_valid( object ) -> interface is_valid()
+ * +- modified_status = v_are_equal( origin, object ) -> interface <structfield>NAObjectClass::are_equal</structfield>
+ * +- valid_status = v_is_valid( object ) -> interface <structfield>NAObjectClass::is_valid</structfield>
*
* Note that the recursivity is managed here, so that we can be sure
* that edition status of childs is actually checked before those of
* the parent.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_object_check_status( const NAObject *object )
@@ -410,10 +412,12 @@ na_object_object_check_status( const NAObject *object )
* Checks for modification and validity status of the @object, its
* parent, the parent of its parent, etc. up to the top of the hierarchy.
*
- * Returns: %TRUE if at least one of the status has changed, %FALSE else.
- *
* Checking the modification of any of the status should be more
* efficient that systematically force the display of the item.
+ *
+ * Returns: %TRUE if at least one of the status has changed, %FALSE else.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
gboolean
na_object_object_check_status_up( const NAObject *object )
@@ -474,11 +478,13 @@ push_modified_status_up( const NAObject *object, gboolean is_modified )
/**
* na_object_object_copy:
- * @target: the target #NAObject-derived object.
- * @source: the source #NAObject-derived object.
+ * @target: the target #NAObject -derived object.
+ * @source: the source #NAObject -derived object.
* @recursive: whether the copy should be recursive.
*
* Copies @source to @target.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_object_copy( NAObject *target, const NAObject *source, gboolean recursive )
@@ -516,16 +522,18 @@ object_copy_iter( GObjectClass *class, const NAObject *source, CopyIter *data )
/**
* na_object_object_dump:
- * @object: the #NAObject-derived object to be dumped.
+ * @object: the #NAObject -derived object to be dumped.
*
- * Dumps via g_debug the actual content of the object.
+ * Dumps via g_debug() the actual content of the object.
*
- * The recursivity is dealt with here. If we let #NAObjectItem do this,
- * the dump of #NAObjectItem-derived object will be splitted, childs
- * being inserted inside.
+ * The recursivity is dealt with here because, if we would let
+ * #NAObjectItem do this, the dump of #NAObjectItem -derived object
+ * would be splitted, childs being inserted inside.
*
* na_object_dump() doesn't modify the reference count of the dumped
* object.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_object_dump( const NAObject *object )
@@ -551,11 +559,13 @@ na_object_object_dump( const NAObject *object )
/**
* na_object_object_dump_norec:
- * @object: the #NAObject-derived object to be dumped.
+ * @object: the #NAObject -derived object to be dumped.
*
* Dumps via g_debug the actual content of the object.
*
* This function is not recursive.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_object_dump_norec( const NAObject *object )
@@ -582,9 +592,11 @@ dump_class_hierarchy_iter( GObjectClass *class, const NAObject *object, void *us
/**
* na_object_object_dump_tree:
- * @tree: a hierarchical list of #NAObject-derived objects.
+ * @tree: a hierarchical list of #NAObject -derived objects.
*
* Outputs a brief, hierarchical dump of the provided list.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_object_dump_tree( GList *tree )
@@ -625,7 +637,7 @@ dump_tree( GList *tree, gint level )
/**
* na_object_object_reset_origin:
- * @object: a #NAObject-derived object.
+ * @object: a #NAObject -derived object.
* @origin: must be a duplication of @object.
*
* Recursively reset origin of @object and its children to @origin (and
@@ -635,6 +647,8 @@ dump_tree( GList *tree, gint level )
*
* This only works if @origin has just been duplicated from @object,
* and thus we do not have to check if children lists are equal.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_object_reset_origin( NAObject *object, const NAObject *origin )
@@ -661,12 +675,14 @@ na_object_object_reset_origin( NAObject *object, const NAObject *origin )
/**
* na_object_object_ref:
- * @object: a #NAObject-derived object.
+ * @object: a #NAObject -derived object.
*
* Recursively ref the @object and all its children, incrementing their
* reference_count by 1.
*
* Returns: a reference on the @pbject.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
NAObject *
na_object_object_ref( NAObject *object )
@@ -702,10 +718,12 @@ na_object_object_ref( NAObject *object )
/**
* na_object_object_unref:
- * @object: a #NAObject-derived object.
+ * @object: a #NAObject -derived object.
*
* Recursively unref the @object and all its children, decrementing their
* reference_count by 1.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_object_unref( NAObject *object )
@@ -786,9 +804,12 @@ build_class_hierarchy( const NAObject *object )
/**
* na_object_object_get_hierarchy:
+ * @object: the #NAObject -derived object.
*
* Returns: the class hierarchy,
* from the topmost base class, to the most-derived one.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
GList *
na_object_object_get_hierarchy( const NAObject *object )
@@ -809,6 +830,12 @@ na_object_object_get_hierarchy( const NAObject *object )
/**
* na_object_free_hierarchy:
+ * @hierarchy: the #GList of hierarchy, as returned from
+ * na_object_get_hierarchy().
+ *
+ * Releases the #NAObject hierarchy.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_free_hierarchy( GList *hierarchy )
@@ -818,10 +845,12 @@ na_object_free_hierarchy( GList *hierarchy )
/**
* na_object_object_debug_invalid:
- * @object: the #NAObject-derived object which is invalid.
+ * @object: the #NAObject -derived object which is invalid.
* @reason: the reason.
*
* Dump the object with the invalidity reason.
+ *
+ * Since: Nautilus-Actions v 2.30.
*/
void
na_object_object_debug_invalid( const NAObject *object, const gchar *reason )
diff --git a/src/core/na-pivot.c b/src/core/na-pivot.c
index d8b0cb2..10eec38 100644
--- a/src/core/na-pivot.c
+++ b/src/core/na-pivot.c
@@ -45,13 +45,13 @@
/* private class data
*/
-struct NAPivotClassPrivate {
+struct _NAPivotClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NAPivotPrivate {
+struct _NAPivotPrivate {
gboolean dispose_has_run;
guint loadable_set;
@@ -361,7 +361,7 @@ iprefs_iface_init( NAIPrefsInterface *iface )
g_debug( "%s: iface=%p", thisfn, ( void * ) iface );
}
-/**
+/*
* na_pivot_new:
*
* Returns: a newly allocated #NAPivot object.
@@ -379,7 +379,7 @@ na_pivot_new( void )
return( pivot );
}
-/**
+/*
* na_pivot_dump:
* @pivot: the #NAPivot object do be dumped.
*
@@ -407,7 +407,7 @@ na_pivot_dump( const NAPivot *pivot )
}
}
-/**
+/*
* na_pivot_get_providers:
* @pivot: this #NAPivot instance.
* @type: the type of searched interface.
@@ -439,7 +439,7 @@ na_pivot_get_providers( const NAPivot *pivot, GType type )
return( list );
}
-/**
+/*
* na_pivot_free_providers:
* @providers: a list of providers.
*
@@ -455,7 +455,7 @@ na_pivot_free_providers( GList *providers )
na_module_free_extensions_list( providers );
}
-/**
+/*
* na_pivot_get_item:
* @pivot: this #NAPivot instance.
* @id: the required item identifier.
@@ -510,7 +510,7 @@ get_item_from_tree( const NAPivot *pivot, GList *tree, const gchar *id )
return( found );
}
-/**
+/*
* na_pivot_get_items:
* @pivot: this #NAPivot instance.
*
@@ -536,7 +536,7 @@ na_pivot_get_items( const NAPivot *pivot )
return( tree );
}
-/**
+/*
* na_pivot_load_items:
* @pivot: this #NAPivot instance.
*
@@ -568,7 +568,7 @@ na_pivot_load_items( NAPivot *pivot )
}
}
-/**
+/*
* na_pivot_set_new_items:
* @pivot: this #NAPivot instance.
* @tree: the new tree of items.
@@ -593,7 +593,7 @@ na_pivot_set_new_items( NAPivot *pivot, GList *items )
}
}
-/**
+/*
* na_pivot_item_changed_handler:
* @provider: the #NAIIOProvider which has emitted the signal.
* @id: the id of the changed #NAObjectItem-derived object.
@@ -679,7 +679,7 @@ time_val_diff( const GTimeVal *recent, const GTimeVal *old )
return( microsec );
}
-/**
+/*
* na_pivot_write_level_zero:
* @pivot: this #NAPivot instance.
* @items: the #GList of items whose first level is to be written.
@@ -727,7 +727,7 @@ na_pivot_write_level_zero( const NAPivot *pivot, GList *items )
return( written );
}
-/**
+/*
* na_pivot_register_consumer:
* @pivot: this #NAPivot instance.
* @consumer: a #NAIPivotConsumer which wishes be notified of any
@@ -759,7 +759,7 @@ free_consumers( GList *consumers )
g_list_free( consumers );
}
-/**
+/*
* na_pivot_set_automatic_reload:
* @pivot: this #NAPivot instance.
* @reload: whether this #NAPivot instance should automatically reload
@@ -784,7 +784,7 @@ na_pivot_set_automatic_reload( NAPivot *pivot, gboolean reload )
}
}
-/**
+/*
* na_pivot_is_disable_loadable:
* @pivot: this #NAPivot instance.
*
@@ -807,7 +807,7 @@ na_pivot_is_disable_loadable( const NAPivot *pivot )
return( is_loadable );
}
-/**
+/*
* na_pivot_is_invalid_loadable:
* @pivot: this #NAPivot instance.
*
@@ -830,7 +830,7 @@ na_pivot_is_invalid_loadable( const NAPivot *pivot )
return( is_loadable );
}
-/**
+/*
* na_pivot_set_loadable:
* @pivot: this #NAPivot instance.
* @loadable: the population of items to be loaded.
@@ -848,7 +848,7 @@ na_pivot_set_loadable( NAPivot *pivot, guint loadable )
}
}
-/**
+/*
* na_pivot_is_level_zero_writable:
* @pivot: this #NAPivot instance.
*
@@ -882,7 +882,7 @@ na_pivot_is_level_zero_writable( const NAPivot *pivot )
return( !all_locked && !gconf_locked );
}
-/**
+/*
* na_pivot_is_configuration_locked_by_admin:
* @pivot: this #NAPivot.
*
diff --git a/src/core/na-pivot.h b/src/core/na-pivot.h
index 1f7b310..84eb377 100644
--- a/src/core/na-pivot.h
+++ b/src/core/na-pivot.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_PIVOT_H__
#define __CORE_NA_PIVOT_H__
-/**
- * SECTION: na_pivot
- * @short_description: #NAPivot class definition.
+/* @title: NAPivot
+ * @short_description: The #NAPivot Class Definition
* @include: core/na-pivot.h
*
* A consuming program should allocate one new NAPivot object in its
@@ -83,24 +82,26 @@
G_BEGIN_DECLS
-#define NA_PIVOT_TYPE ( na_pivot_get_type())
-#define NA_PIVOT( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_PIVOT_TYPE, NAPivot ))
-#define NA_PIVOT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_PIVOT_TYPE, NAPivotClass ))
-#define NA_IS_PIVOT( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_PIVOT_TYPE ))
-#define NA_IS_PIVOT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_PIVOT_TYPE ))
-#define NA_PIVOT_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_PIVOT_TYPE, NAPivotClass ))
+#define NA_PIVOT_TYPE ( na_pivot_get_type())
+#define NA_PIVOT( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_PIVOT_TYPE, NAPivot ))
+#define NA_PIVOT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_PIVOT_TYPE, NAPivotClass ))
+#define NA_IS_PIVOT( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_PIVOT_TYPE ))
+#define NA_IS_PIVOT_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_PIVOT_TYPE ))
+#define NA_PIVOT_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_PIVOT_TYPE, NAPivotClass ))
-typedef struct NAPivotPrivate NAPivotPrivate;
+typedef struct _NAPivotPrivate NAPivotPrivate;
typedef struct {
+ /*< private >*/
GObject parent;
NAPivotPrivate *private;
}
NAPivot;
-typedef struct NAPivotClassPrivate NAPivotClassPrivate;
+typedef struct _NAPivotClassPrivate NAPivotClassPrivate;
typedef struct {
+ /*< private >*/
GObjectClass parent;
NAPivotClassPrivate *private;
}
diff --git a/src/core/na-selected-info.c b/src/core/na-selected-info.c
index 001a55d..782534f 100644
--- a/src/core/na-selected-info.c
+++ b/src/core/na-selected-info.c
@@ -40,13 +40,13 @@
/* private class data
*/
-struct NASelectedInfoClassPrivate {
+struct _NASelectedInfoClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NASelectedInfoPrivate {
+struct _NASelectedInfoPrivate {
gboolean dispose_has_run;
gchar *uri;
NAGnomeVFSURI *vfs;
@@ -193,7 +193,7 @@ instance_finalize( GObject *object )
}
}
-/**
+/*
* na_selected_info_get_list_from_item:
* @item: a #NautilusFileInfo item
*
@@ -215,7 +215,7 @@ na_selected_info_get_list_from_item( NautilusFileInfo *item )
return( selected );
}
-/**
+/*
* na_selected_info_get_list_from_list:
* @nautilus_selection: a #GList list of #NautilusFileInfo items.
*
@@ -241,7 +241,7 @@ na_selected_info_get_list_from_list( GList *nautilus_selection )
return( selected ? g_list_reverse( selected ) : NULL );
}
-/**
+/*
* na_selected_info_copy_list:
* @files: a #GList list of #NASelectedInfo items.
*
@@ -262,7 +262,7 @@ na_selected_info_copy_list( GList *files )
return( copy );
}
-/**
+/*
* na_selected_info_free_list:
* @files: a #GList of #NASelectedInfo items.
*
@@ -275,7 +275,7 @@ na_selected_info_free_list( GList *files )
g_list_free( files );
}
-/**
+/*
* na_selected_info_get_location:
* @nsi: this #NASelectedInfo object.
*
@@ -300,7 +300,7 @@ na_selected_info_get_location( const NASelectedInfo *nsi )
return( location );
}
-/**
+/*
* na_selected_info_get_basename:
* @nsi: this #NASelectedInfo object.
*
@@ -325,7 +325,7 @@ na_selected_info_get_basename( const NASelectedInfo *nsi )
return( basename );
}
-/**
+/*
* na_selected_info_get_dirname:
* @nsi: this #NASelectedInfo object.
*
@@ -350,7 +350,7 @@ na_selected_info_get_dirname( const NASelectedInfo *nsi )
return( dirname );
}
-/**
+/*
* na_selected_info_get_mime_type:
* @nsi: this #NASelectedInfo object.
*
@@ -376,7 +376,7 @@ na_selected_info_get_mime_type( const NASelectedInfo *nsi )
return( mimetype );
}
-/**
+/*
* na_selected_info_get_path:
* @nsi: this #NASelectedInfo object.
*
@@ -399,7 +399,7 @@ na_selected_info_get_path( const NASelectedInfo *nsi )
return( path );
}
-/**
+/*
* na_selected_info_get_uri:
* @nsi: this #NASelectedInfo object.
*
@@ -423,7 +423,7 @@ na_selected_info_get_uri( const NASelectedInfo *nsi )
return( uri );
}
-/**
+/*
* na_selected_info_get_uri_scheme:
* @nsi: this #NASelectedInfo object.
*
@@ -447,7 +447,7 @@ na_selected_info_get_uri_scheme( const NASelectedInfo *nsi )
return( scheme );
}
-/**
+/*
* na_selected_info_is_directory:
* @nsi: this #NASelectedInfo object.
*
@@ -470,7 +470,7 @@ na_selected_info_is_directory( const NASelectedInfo *nsi )
return( is_dir );
}
-/**
+/*
* na_selected_info_is_executable:
* @nsi: this #NASelectedInfo object.
*
@@ -493,7 +493,7 @@ na_selected_info_is_executable( const NASelectedInfo *nsi )
return( is_exe );
}
-/**
+/*
* na_selected_info_is_local:
* @nsi: this #NASelectedInfo object.
*
@@ -519,7 +519,7 @@ na_selected_info_is_local( const NASelectedInfo *nsi )
return( is_local );
}
-/**
+/*
* na_selected_info_is_owner:
* @nsi: this #NASelectedInfo object.
* @user: the user to be tested against the owner of the @nsi object.
@@ -543,7 +543,7 @@ na_selected_info_is_owner( const NASelectedInfo *nsi, const gchar *user )
return( is_owner );
}
-/**
+/*
* na_selected_info_is_readable:
* @nsi: this #NASelectedInfo object.
*
@@ -566,7 +566,7 @@ na_selected_info_is_readable( const NASelectedInfo *nsi )
return( is_readable );
}
-/**
+/*
* na_selected_info_is_writable:
* @nsi: this #NASelectedInfo object.
*
@@ -589,7 +589,7 @@ na_selected_info_is_writable( const NASelectedInfo *nsi )
return( is_writable );
}
-/**
+/*
* na_selected_info_create_for_uri:
* @uri: an URI.
* @mimetype: the corresponding Nautilus mime type, or %NULL.
diff --git a/src/core/na-selected-info.h b/src/core/na-selected-info.h
index c316d5d..c8d9cba 100644
--- a/src/core/na-selected-info.h
+++ b/src/core/na-selected-info.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_SELECTED_INFO_H__
#define __CORE_NA_SELECTED_INFO_H__
-/**
- * SECTION: na_selected_info
- * @short_description: #NASelectedInfo class definition.
+/* @title: NASelectedInfo
+ * @short_description: The #NASelectedInfo Class Definition
* @include: core/na-selected-info.h
*
* An object is instantiated for each Nautilus selected item, in order
@@ -49,24 +48,26 @@
G_BEGIN_DECLS
-#define NA_SELECTED_INFO_TYPE ( na_selected_info_get_type())
-#define NA_SELECTED_INFO( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_SELECTED_INFO_TYPE, NASelectedInfo ))
-#define NA_SELECTED_INFO_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_SELECTED_INFO_TYPE, NASelectedInfoClass ))
-#define NA_IS_SELECTED_INFO( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_SELECTED_INFO_TYPE ))
-#define NA_IS_SELECTED_INFO_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_SELECTED_INFO_TYPE ))
-#define NA_SELECTED_INFO_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_SELECTED_INFO_TYPE, NASelectedInfoClass ))
+#define NA_SELECTED_INFO_TYPE ( na_selected_info_get_type())
+#define NA_SELECTED_INFO( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_SELECTED_INFO_TYPE, NASelectedInfo ))
+#define NA_SELECTED_INFO_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_SELECTED_INFO_TYPE, NASelectedInfoClass ))
+#define NA_IS_SELECTED_INFO( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_SELECTED_INFO_TYPE ))
+#define NA_IS_SELECTED_INFO_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_SELECTED_INFO_TYPE ))
+#define NA_SELECTED_INFO_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_SELECTED_INFO_TYPE, NASelectedInfoClass ))
-typedef struct NASelectedInfoPrivate NASelectedInfoPrivate;
+typedef struct _NASelectedInfoPrivate NASelectedInfoPrivate;
typedef struct {
+ /*< private >*/
GObject parent;
NASelectedInfoPrivate *private;
}
NASelectedInfo;
-typedef struct NASelectedInfoClassPrivate NASelectedInfoClassPrivate;
+typedef struct _NASelectedInfoClassPrivate NASelectedInfoClassPrivate;
typedef struct {
+ /*< private >*/
GObjectClass parent;
NASelectedInfoClassPrivate *private;
}
diff --git a/src/core/na-tokens.c b/src/core/na-tokens.c
index 90bff5c..7c2c3f5 100644
--- a/src/core/na-tokens.c
+++ b/src/core/na-tokens.c
@@ -44,13 +44,13 @@
/* private class data
*/
-struct NATokensClassPrivate {
+struct _NATokensClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NATokensPrivate {
+struct _NATokensPrivate {
gboolean dispose_has_run;
guint count;
@@ -239,7 +239,7 @@ instance_finalize( GObject *object )
}
}
-/**
+/*
* na_tokens_new_for_example:
*
* Returns: a new #NATokens object initialized with fake values for two
@@ -300,7 +300,7 @@ na_tokens_new_for_example( void )
return( build_string_lists( tokens ));
}
-/**
+/*
* na_tokens_new_from_selection:
* @selection: a #GList list of #NASelectedInfo objects.
*
@@ -364,7 +364,7 @@ na_tokens_new_from_selection( GList *selection )
return( build_string_lists( tokens ));
}
-/**
+/*
* na_tokens_parse_parameters:
* @tokens: a #NATokens object.
* @string: the input string, may or may not contain tokens.
@@ -381,7 +381,7 @@ na_tokens_parse_parameters( const NATokens *tokens, const gchar *string, gboolea
return( parse_singular( tokens, string, 0, utf8 ));
}
-/**
+/*
* na_tokens_execute_action:
* @tokens: a #NATokens object.
* @profile: the #NAObjectProfile to be executed.
diff --git a/src/core/na-tokens.h b/src/core/na-tokens.h
index 113477f..de4b58c 100644
--- a/src/core/na-tokens.h
+++ b/src/core/na-tokens.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_TOKENS_H__
#define __CORE_NA_TOKENS_H__
-/**
- * SECTION: na_tokens
- * @short_description: #NATokens class definition.
+/* @title: NATokens
+ * @short_description: The #NATokens Class Definition
* @include: core/na-tokens.h
*
* The #NATokens class manages the tokens which are to be replaced with
@@ -85,24 +84,26 @@
G_BEGIN_DECLS
-#define NA_TOKENS_TYPE ( na_tokens_get_type())
-#define NA_TOKENS( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_TOKENS_TYPE, NATokens ))
-#define NA_TOKENS_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_TOKENS_TYPE, NATokensClass ))
-#define NA_IS_TOKENS( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_TOKENS_TYPE ))
-#define NA_IS_TOKENS_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_TOKENS_TYPE ))
-#define NA_TOKENS_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_TOKENS_TYPE, NATokensClass ))
+#define NA_TOKENS_TYPE ( na_tokens_get_type())
+#define NA_TOKENS( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_TOKENS_TYPE, NATokens ))
+#define NA_TOKENS_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_TOKENS_TYPE, NATokensClass ))
+#define NA_IS_TOKENS( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_TOKENS_TYPE ))
+#define NA_IS_TOKENS_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_TOKENS_TYPE ))
+#define NA_TOKENS_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_TOKENS_TYPE, NATokensClass ))
-typedef struct NATokensPrivate NATokensPrivate;
+typedef struct _NATokensPrivate NATokensPrivate;
typedef struct {
+ /*< private >*/
GObject parent;
NATokensPrivate *private;
}
NATokens;
-typedef struct NATokensClassPrivate NATokensClassPrivate;
+typedef struct _NATokensClassPrivate NATokensClassPrivate;
typedef struct {
+ /*< private >*/
GObjectClass parent;
NATokensClassPrivate *private;
}
diff --git a/src/core/na-updater.c b/src/core/na-updater.c
index 6b3b360..1de44fd 100644
--- a/src/core/na-updater.c
+++ b/src/core/na-updater.c
@@ -40,13 +40,13 @@
/* private class data
*/
-struct NAUpdaterClassPrivate {
+struct _NAUpdaterClassPrivate {
void *empty; /* so that gcc -pedantic is happy */
};
/* private instance data
*/
-struct NAUpdaterPrivate {
+struct _NAUpdaterPrivate {
gboolean dispose_has_run;
};
@@ -170,7 +170,7 @@ instance_finalize( GObject *object )
}
}
-/**
+/*
* na_updater_new:
*
* Returns: a newly allocated #NAUpdater object.
@@ -188,7 +188,7 @@ na_updater_new( void )
return( updater );
}
-/**
+/*
* na_updater_append_item:
* @updater: this #NAUpdater object.
* @item: a #NAObjectItem-derived object to be appended to the tree.
@@ -211,7 +211,7 @@ na_updater_append_item( NAUpdater *updater, NAObjectItem *item )
}
}
-/**
+/*
* na_updater_insert_item:
* @updater: this #NAUpdater object.
* @item: a #NAObjectItem-derived object to be inserted in the tree.
@@ -248,7 +248,7 @@ na_updater_insert_item( NAUpdater *updater, NAObjectItem *item, const gchar *par
}
}
-/**
+/*
* na_updater_remove_item:
* @updater: this #NAPivot instance.
* @item: the #NAObjectItem to be removed from the list.
@@ -283,7 +283,7 @@ na_updater_remove_item( NAUpdater *updater, NAObject *item )
}
}
-/**
+/*
* na_updater_is_item_writable:
* @updater: this #NAUpdater object.
* @item: the #NAObjectItem to be written.
@@ -377,7 +377,7 @@ na_updater_is_item_writable( const NAUpdater *updater, const NAObjectItem *item,
return( writable );
}
-/**
+/*
* na_updater_write_item:
* @updater: this #NAUpdater instance.
* @item: a #NAObjectItem to be written down to the storage subsystem.
@@ -427,7 +427,7 @@ na_updater_write_item( const NAUpdater *updater, NAObjectItem *item, GSList **me
return( ret );
}
-/**
+/*
* na_updater_delete_item:
* @updater: this #NAUpdater instance.
* @item: the #NAObjectItem to be deleted from the storage subsystem.
diff --git a/src/core/na-updater.h b/src/core/na-updater.h
index 0ae1348..eb4d62f 100644
--- a/src/core/na-updater.h
+++ b/src/core/na-updater.h
@@ -31,9 +31,8 @@
#ifndef __CORE_NA_UPDATER_H__
#define __CORE_NA_UPDATER_H__
-/**
- * SECTION: na_updater
- * @short_description: #NAUpdater class definition.
+/* @title: NAUpdater
+ * @short_description: The #NAUpdater Class Definition
* @include: core/na-updater.h
*
* #NAUpdater is a #NAPivot-derived class which allows its clients
@@ -44,24 +43,26 @@
G_BEGIN_DECLS
-#define NA_UPDATER_TYPE ( na_updater_get_type())
-#define NA_UPDATER( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_UPDATER_TYPE, NAUpdater ))
-#define NA_UPDATER_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_UPDATER_TYPE, NAUpdaterClass ))
-#define NA_IS_UPDATER( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_UPDATER_TYPE ))
-#define NA_IS_UPDATER_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_UPDATER_TYPE ))
-#define NA_UPDATER_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_UPDATER_TYPE, NAUpdaterClass ))
+#define NA_UPDATER_TYPE ( na_updater_get_type())
+#define NA_UPDATER( object ) ( G_TYPE_CHECK_INSTANCE_CAST( object, NA_UPDATER_TYPE, NAUpdater ))
+#define NA_UPDATER_CLASS( klass ) ( G_TYPE_CHECK_CLASS_CAST( klass, NA_UPDATER_TYPE, NAUpdaterClass ))
+#define NA_IS_UPDATER( object ) ( G_TYPE_CHECK_INSTANCE_TYPE( object, NA_UPDATER_TYPE ))
+#define NA_IS_UPDATER_CLASS( klass ) ( G_TYPE_CHECK_CLASS_TYPE(( klass ), NA_UPDATER_TYPE ))
+#define NA_UPDATER_GET_CLASS( object ) ( G_TYPE_INSTANCE_GET_CLASS(( object ), NA_UPDATER_TYPE, NAUpdaterClass ))
-typedef struct NAUpdaterPrivate NAUpdaterPrivate;
+typedef struct _NAUpdaterPrivate NAUpdaterPrivate;
typedef struct {
+ /*< private >*/
NAPivot parent;
NAUpdaterPrivate *private;
}
NAUpdater;
-typedef struct NAUpdaterClassPrivate NAUpdaterClassPrivate;
+typedef struct _NAUpdaterClassPrivate NAUpdaterClassPrivate;
typedef struct {
+ /*< private >*/
NAPivotClass parent;
NAUpdaterClassPrivate *private;
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
