[nautilus-actions/file-manager-actions] Review reference documentation
- From: Pierre Wieser <pwieser src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [nautilus-actions/file-manager-actions] Review reference documentation
- Date: Fri, 11 Sep 2015 07:43:54 +0000 (UTC)
commit b44697e81c67c7c42f63d801144f178e6b93ef20
Author: Pierre Wieser <pwieser trychlos org>
Date: Fri Sep 11 09:43:14 2015 +0200
Review reference documentation
docs/reference/filemanager-actions-docs.xml | 4 +-
docs/reference/fma-compiling.xml | 160 +++++++++++----------------
docs/reference/fma-dist-content.xml | 14 ++-
src/api/fma-dbus.h | 8 +-
src/api/fma-extension.h | 30 +++--
src/api/fma-iexporter.h | 55 +++------
src/api/fma-ifactory-object.h | 26 ++++-
src/api/fma-ifactory-provider.h | 34 +++++-
src/api/fma-iimporter.h | 4 +-
src/api/fma-iio-provider.h | 72 ++++++++++---
src/core/fma-data-boxed.c | 10 +-
src/core/fma-iio-provider.c | 12 +-
src/core/fma-importer.h | 2 +-
src/core/fma-object.c | 6 +-
src/core/fma-pivot.h | 2 +-
src/io-desktop/fma-desktop-reader.c | 4 +-
src/io-xml/fma-xml-reader.c | 2 +-
src/plugin-menu/fma-menu-module.c | 2 +-
src/plugin-tracker/fma-tracker-module.c | 2 +-
src/utils/fma-gconf2key.sh.in | 2 +-
src/utils/fma-set-conf.c | 2 +-
21 files changed, 247 insertions(+), 206 deletions(-)
---
diff --git a/docs/reference/filemanager-actions-docs.xml b/docs/reference/filemanager-actions-docs.xml
index d965e84..a9b7ce7 100644
--- a/docs/reference/filemanager-actions-docs.xml
+++ b/docs/reference/filemanager-actions-docs.xml
@@ -39,11 +39,11 @@
<chapter>
<title>&prodname; Overview</title>
+ <xi:include href="fma-about.xml" />
<xi:include href="fma-what-is-it.xml" />
<xi:include href="fma-getting.xml" />
<xi:include href="fma-dist-content.xml" />
<xi:include href="fma-compiling.xml" />
- <xi:include href="fma-about.xml" />
</chapter>
<chapter>
@@ -75,7 +75,7 @@
</chapter>
<chapter>
- <title>NAObject Hierarchy</title>
+ <title>FMAObject Hierarchy</title>
<xi:include href="xml/object.xml"/>
<xi:include href="xml/object-id.xml"/>
<xi:include href="xml/object-item.xml"/>
diff --git a/docs/reference/fma-compiling.xml b/docs/reference/fma-compiling.xml
index cb8bc53..4cb0c73 100644
--- a/docs/reference/fma-compiling.xml
+++ b/docs/reference/fma-compiling.xml
@@ -27,16 +27,56 @@
<para>
On UNIX, &prodname; uses the standard GNU build system,
- using <ulink url="http://www.gnu.org/software/autoconf/";>
- <application>autoconf</application></ulink> for package
- configuration and resolving portability issues,
- <ulink url="http://www.gnu.org/software/automake/";>
- <application>automake</application></ulink> for building makefiles
- that comply with the GNU Coding Standards, and
- <ulink url="http://www.gnu.org/software/libtool/";>
- <application>libtool</application></ulink> for building shared
- libraries on multiple platforms. The normal sequence for
- compiling and installing the &prodname; package is thus:
+ using
+ <itemized list>
+ <listitem>
+ <para>
+ <ulink url="http://www.gnu.org/software/autoconf/";>
+ <application>autoconf</application></ulink> for configuring
+ the package and resolving portability issues,
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.gnu.org/software/automake/";>
+ <application>automake</application></ulink> for building
+ makefiles that comply with the GNU Coding Standards;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.gnu.org/software/libtool/";>
+ <application>libtool</application></ulink> for building
+ shared libraries which target multiple platforms;
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.freedesktop.org/software/pkgconfig/";>pkg-config</ulink>
+ for tracking the compilation flags needed by used libraries
+ (For each library, a small <literal>.pc</literal> text file is
+ installed in a standard location that contains the compilation
+ flags needed for that library along with version number
+ information);
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://www.gnu.org/software/make";>GNU make</ulink>
+ for actually building.
+ </para>
+ <para>
+ The &prodname; makefiles will mostly work with different versions
+ of <command>make</command>. However, there tends to be
+ a few incompatibilities, so the &prodname; team recommends
+ installing <ulink url="http://www.gnu.org/software/make";>GNU make</ulink>
+ if you don't already have it on your system.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ The normal sequence for compiling and installing the &prodname;
+ package is thus:
<literallayout>
<userinput>./configure</userinput>
@@ -60,40 +100,6 @@
<title>Dependencies</title>
<para>
- Before you can compile the &prodname; package, you need to have
- various other tools and libraries installed on your
- system. The two main tools needed during the build process (as
- differentiated from the tools used in when creating &prodname;
- mentioned above such as <application>autoconf</application>)
- are <command>pkg-config</command> and GNU make.
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="http://www.freedesktop.org/software/pkgconfig/";>pkg-config</ulink>
- is a tool for tracking the compilation flags needed for
- libraries that are used by the &prodname; package.
- (For each library, a small <literal>.pc</literal> text file is
- installed in a standard location that contains the compilation
- flags needed for that library along with version number
- information.)
- </para>
- </listitem>
- <listitem>
- <para>
- The &prodname; makefiles will mostly work with different versions
- of <command>make</command>. However, there tends to be
- a few incompatibilities, so the &prodname; team recommends
- installing <ulink url="http://www.gnu.org/software/make";>GNU
- make</ulink> if you don't already have it on your system
- and using it. (It may be called <command>gmake</command>
- rather than <command>make</command>.)
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
&prodname; depends on a number of other libraries.
</para>
@@ -138,13 +144,13 @@
<listitem>
<para>
<ulink url="http://projects.gnome.org/nautilus/";>&nautilus; extension</ulink>
- is needed if you want build &nautilus; extension.
+ is needed if you want build &nautilus; extensions.
</para>
</listitem>
<listitem>
<para>
<ulink url="https://github.com/linuxmint/nemo/";>&nemo; extension</ulink>
- is needed if you want build &nemo; extension.
+ is needed if you want build &nemo; extensions.
</para>
</listitem>
</itemizedlist>
@@ -162,17 +168,13 @@
<command>configure</command>
<group>
<arg>--with-nautilus-extdir=DIR</arg>
- </group>
- <group>
<arg>--with-nemo-extdir=DIR</arg>
- </group>
- <group>
- <arg>--with-default-io-provider=na-gconf|io-desktop</arg>
- </group>
- <group>
+ <!-- pwi 2015- 9-11
+ this is removed from the documentation
+ is io-gconf is deprecated
+ <arg>--with-default-io-provider=io-gconf|io-desktop</arg>
+ -->
<arg>--enable-html-manuals[=gdt|db2html]</arg>
- </group>
- <group>
<arg>--enable-pdf-manuals[=dblatex]</arg>
</group>
</cmdsynopsis>
@@ -180,42 +182,10 @@
<formalpara>
<title><systemitem>--with-nautilus-extdir=DIR</systemitem></title>
- <para>
- With this option, one may define an alternate directory where
- our &nautilus; extensions will be stored.
- </para>
- <para>
- This is most commonly useful:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- In development mode, we only have to install symlinks
- from &nautilus; standard location to our development
- tree once. Then, each new version of our libraries
- will be automatically considered by &nautilus;.
- </para>
- </listitem>
- <listitem>
- <para>
- When running <command>make distcheck</command>, so that
- compiled libraries do not interfere with installed ones.
- </para>
- </listitem>
- <listitem>
- <para>
- When &nautilus; is not installed itself in a standard
- location.
- </para>
- </listitem>
- </itemizedlist>
- </formalpara>
-
- <formalpara>
<title><systemitem>--with-nemo-extdir=DIR</systemitem></title>
<para>
With this option, one may define an alternate directory where
- our &nemo; extensions will be stored.
+ our file manager extensions will be stored.
</para>
<para>
This is most commonly useful:
@@ -224,9 +194,9 @@
<listitem>
<para>
In development mode, we only have to install symlinks
- from &nemo; standard location to our development
+ from the file manager standard location to our development
tree once. Then, each new version of our libraries
- will be automatically considered by &nemo;.
+ will be automatically considered by the file manager.
</para>
</listitem>
<listitem>
@@ -237,13 +207,14 @@
</listitem>
<listitem>
<para>
- When &nemo; is not installed itself in a standard
+ When the file manager is not installed itself in its standard
location.
</para>
</listitem>
</itemizedlist>
</formalpara>
+<!--
<formalpara>
<title><systemitem>--with-default-io-provider=io-desktop</systemitem></title>
<para>
@@ -261,6 +232,7 @@
<filename>.desktop</filename> files.
</para>
</formalpara>
+ -->
<formalpara>
<title><systemitem>--enable-html-manuals[=gdt|db2html]</systemitem></title>
@@ -276,14 +248,14 @@
realized through <application>gnome-doc-tool</application>
or <application>db2html</application>.
&prodname; defaults to use <application>gnome-doc-tool</application>
- as the output format better sticks with those of
+ as its output format better sticks with those of
<application>Yelp</application>.
</para>
<para>
As this option is always set when running
<command>make distcheck</command>, the packager can be
mostly sure that the distributed manuals are up to date,
- and may safely ignore this option.
+ and may safely ignore it.
</para>
</formalpara>
@@ -300,7 +272,7 @@
As this option is always set when running
<command>make distcheck</command>, the packager can be
mostly sure that the distributed manuals are up to date,
- and may safely ignore this option.
+ and may safely ignore it.
</para>
</formalpara>
diff --git a/docs/reference/fma-dist-content.xml b/docs/reference/fma-dist-content.xml
index add3ef1..19901bf 100644
--- a/docs/reference/fma-dist-content.xml
+++ b/docs/reference/fma-dist-content.xml
@@ -29,13 +29,13 @@
<itemizedlist>
<listitem>
<para>
- Program sources
+ Some executables
</para>
<itemizedlist>
<listitem>
a file-manager plugin, said <emphasis>menu</emphasis>,
responsible for managing displayed menus and actions
- through &nautilus; extension system;
+ through the file manager extension system;
</listitem>
<listitem>
a file-manager plugin, said <emphasis>tracker</emphasis>,
@@ -51,15 +51,19 @@
command-line utility for defining a new action;
</listitem>
<listitem>
+ <application>fma-print</application> is a
+ command-line utility for printing an action;
+ </listitem>
+ <listitem>
<application>fma-run</application> is a
command-line utility for running an existing action,
- taking into account the current file-manager selection;
+ taking into account the current file-manager selection.
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
- Documentation
+ The documentation
</para>
<itemizedlist>
<listitem>
@@ -77,7 +81,7 @@
</listitem>
<listitem>
<para>
- Samples
+ Samples from the user's manual
</para>
<itemizedlist>
<listitem>
diff --git a/src/api/fma-dbus.h b/src/api/fma-dbus.h
index 1a0076c..70fceea 100644
--- a/src/api/fma-dbus.h
+++ b/src/api/fma-dbus.h
@@ -42,13 +42,13 @@
*
* <note>
* <para>
- * To be really clear, &prodname; relies on &nautilus; in order
- * to be able to register its own D-Bus services via the
+ * To be really clear, &prodname; relies on a running file manager
+ * in order to be able to register its own D-Bus services via the
* <emphasis>tracker</emphasis> plugin.
* </para>
* <para>
- * If &nautilus; does not run, or the <emphasis>tracker</emphasis>
- * plugin is not loaded at &nautilus; startup, then these D-Bus
+ * If the file manager does not run, or the <emphasis>tracker</emphasis>
+ * plugin is not loaded at file manager startup, then these D-Bus
* services will not be available.
* </para>
* </note>
diff --git a/src/api/fma-extension.h b/src/api/fma-extension.h
index b092514..e31efdb 100644
--- a/src/api/fma-extension.h
+++ b/src/api/fma-extension.h
@@ -85,7 +85,8 @@
* </itemizedlist>
*
* In order to be recognized as a valid &prodname; plugin, the library
- * must at least export the functions described in this extension API.
+ * must at least export the functions described as mandatory in this
+ * extension API.
*
* <refsect2>
* <title>Developing a &prodname; plugin</title>
@@ -98,13 +99,13 @@
* <application><ulink url="http://www.gnu.org/software/automake/";>automake</ulink></application>
* and
* <application><ulink url="http://www.gnu.org/software/libtool/";>libtool</ulink></application>
- * GNU applications.
+ * GNU tools.
* </para>
* <para>
* In this case, it should be enough to use the <option>-module</option>
* option in your <filename>Makefile.am</filename>, as in:
* <programlisting>
- * libna_io_desktop_la_LDFLAGS = -module -no-undefined -avoid-version
+ * libfma_io_desktop_la_LDFLAGS = -module -no-undefined -avoid-version
* </programlisting>
* </para>
* </refsect3>
@@ -160,8 +161,9 @@ G_BEGIN_DECLS
* advantage of this call by initializing itself, registering its
* internal #GType types, etc.
*
- * A FileManager-Actions extension must implement this function in order
- * to be considered as a valid candidate to dynamic load.
+ * This function is mandatory: a FileManager-Actions extension must
+ * implement this function in order to be considered as a valid candidate
+ * to dynamic load.
*
* <example>
* <programlisting>
@@ -235,8 +237,9 @@ guint fma_extension_get_version( void );
* derived object for each returned #GType type, and associate these objects
* to this library.
*
- * A FileManager-Actions extension must implement this function in order
- * to be considered as a valid candidate to dynamic load.
+ * This function is mandatory: a FileManager-Actions extension must
+ * implement this function in order to be considered as a valid candidate
+ * to dynamic load.
*
* <example>
* <programlisting>
@@ -245,22 +248,22 @@ guint fma_extension_get_version( void );
* * - be registered in fma_extension_startup()
* * - be addressed in fma_extension_list_types().
* &rcomment;
- * #define NADP_TYPES_COUNT 1
+ * #define TYPES_COUNT 1
*
* guint
* fma_extension_list_types( const GType **types )
* {
- * static GType types_list [1+NADP_TYPES_COUNT];
+ * static GType types_list [1+TYPES_COUNT];
*
* &lcomment; FMA_TYPE_DESKTOP_PROVIDER has been previously
* * registered in fma_extension_startup function
* &rcomment;
* types_list[0] = FMA_TYPE_DESKTOP_PROVIDER;
*
- * types_list[NADP_TYPES_COUNT] = 0;
+ * types_list[TYPES_COUNT] = 0;
* *types = types_list;
*
- * return( NADP_TYPES_COUNT );
+ * return( TYPES_COUNT );
* }
* </programlisting>
* </example>
@@ -282,8 +285,9 @@ guint fma_extension_list_types ( const GType **types );
* release any resource, handle, and so on, it may have previously
* allocated.
*
- * A FileManager-Actions extension must implement this function in order
- * to be considered as a valid candidate to dynamic load.
+ * This function is mandatory: a FileManager-Actions extension must
+ * implement this function in order to be considered as a valid
+ * candidate to dynamic load.
*
* Since: 2.30
*/
diff --git a/src/api/fma-iexporter.h b/src/api/fma-iexporter.h
index 76a315e..9db2d3e 100644
--- a/src/api/fma-iexporter.h
+++ b/src/api/fma-iexporter.h
@@ -54,7 +54,7 @@
* </para>
* <para>
* Below is a list of currently allocated export format identifiers.
- * This list has been last updated on 2010, July 28th.
+ * This list has been last updated on 2015, September 10th.
* </para>
* <table>
* <title>Currently allocated export format identifiers</title>
@@ -63,12 +63,16 @@
* <colspec colname="label" />
* <colspec colname="holder" />
* <colspec colname="allocated" align="center" />
+ * <colspec colname="deprecated" />
+ * <colspec colname="current" />
* <thead>
* <row>
* <entry>Identifier</entry>
* <entry>Name</entry>
* <entry>Holder</entry>
* <entry>Allocated on</entry>
+ * <entry></entry>
+ * <entry></entry>
* </row>
* </thead>
* <tbody>
@@ -77,30 +81,40 @@
* <entry>Reserved for &prodname; internal needs</entry>
* <entry>&prodname;</entry>
* <entry>2010-02-15</entry>
+ * <entry></entry>
+ * <entry>current</entry>
* </row>
* <row>
* <entry><literal>Desktop1</literal></entry>
* <entry>FMA Desktop module</entry>
* <entry>&prodname;</entry>
* <entry>2010-07-28</entry>
+ * <entry></entry>
+ * <entry>current</entry>
* </row>
* <row>
* <entry><literal>GConfSchemaV1</literal></entry>
* <entry>FMA XML module</entry>
* <entry>&prodname;</entry>
* <entry>2010-02-15</entry>
+ * <entry>deprecated</entry>
+ * <entry></entry>
* </row>
* <row>
* <entry><literal>GConfSchemaV2</literal></entry>
* <entry>FMA XML module</entry>
* <entry>&prodname;</entry>
* <entry>2010-02-15</entry>
+ * <entry>deprecated</entry>
+ * <entry></entry>
* </row>
* <row>
* <entry><literal>GConfEntry</literal></entry>
* <entry>FMA XML module</entry>
* <entry>&prodname;</entry>
* <entry>2010-02-15</entry>
+ * <entry>deprecated</entry>
+ * <entry></entry>
* </row>
* </tbody>
* </tgroup>
@@ -114,8 +128,8 @@
* <tgroup rowsep="1" colsep="1" align="center" cols="3">
* <colspec colname="fma-version" />
* <colspec colname="api-version" />
- * <colspec colname="current" />
* <colspec colname="deprecated" />
+ * <colspec colname="current" />
* <thead>
* <row>
* <entry>&prodname; version</entry>
@@ -128,14 +142,14 @@
* <row>
* <entry>from 2.30 to 3.1.5</entry>
* <entry>1</entry>
- * <entry></entry>
* <entry>deprecated</entry>
+ * <entry></entry>
* </row>
* <row>
* <entry>since 3.2</entry>
* <entry>2</entry>
- * <entry>current version</entry>
* <entry></entry>
+ * <entry>current version</entry>
* </row>
* </tbody>
* </tgroup>
@@ -263,42 +277,11 @@ typedef struct {
*
* This structure describes a supported output format.
* It must be provided by each #FMAIExporter implementation
- * (see e.g. <filename>src/io-xml/naxml-formats.c</filename>).
+ * (see e.g. <filename>src/io-xml/fma-xml-formats.c</filename>).
*
* When listing available export formats, the @provider must return a #GList
* of these structures.
*
- * <refsect2>
- * <title>Versions historic</title>
- * <table>
- * <title>Historic of the versions of the #FMAIExporterFormatv2 structure</title>
- * <tgroup rowsep="1" colsep="1" align="center" cols="3">
- * <colspec colname="fma-version" />
- * <colspec colname="api-version" />
- * <colspec colname="current" />
- * <thead>
- * <row>
- * <entry>&prodname; version</entry>
- * <entry>#FMAIExporterFormatv2 structure version</entry>
- * <entry></entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>since 2.30</entry>
- * <entry>1</entry>
- * <entry></entry>
- * </row>
- * <row>
- * <entry>since 3.2</entry>
- * <entry>2</entry>
- * <entry>current version</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </table>
- * </refsect2>
- *
* Since: 3.2
*/
typedef struct {
diff --git a/src/api/fma-ifactory-object.h b/src/api/fma-ifactory-object.h
index 70744e0..97898e7 100644
--- a/src/api/fma-ifactory-object.h
+++ b/src/api/fma-ifactory-object.h
@@ -145,7 +145,8 @@ typedef struct {
*
* Since: 2.30
*/
- void ( *copy ) ( FMAIFactoryObject *instance, const FMAIFactoryObject *source );
+ void ( *copy ) ( FMAIFactoryObject *instance,
+ const FMAIFactoryObject
*source );
/**
* are_equal:
@@ -159,7 +160,8 @@ typedef struct {
*
* Since: 2.30
*/
- gboolean ( *are_equal ) ( const FMAIFactoryObject *a, const FMAIFactoryObject *b );
+ gboolean ( *are_equal ) ( const FMAIFactoryObject *a,
+ const FMAIFactoryObject *b );
/**
* is_valid:
@@ -186,7 +188,10 @@ typedef struct {
*
* Since: 2.30
*/
- void ( *read_start ) ( FMAIFactoryObject *instance, const FMAIFactoryProvider *reader, void
*reader_data, GSList **messages );
+ void ( *read_start ) ( FMAIFactoryObject *instance,
+ const FMAIFactoryProvider
*reader,
+ void *reader_data,
+ GSList **messages );
/**
* read_done:
@@ -200,7 +205,10 @@ typedef struct {
*
* Since: 2.30
*/
- void ( *read_done ) ( FMAIFactoryObject *instance, const FMAIFactoryProvider *reader, void
*reader_data, GSList **messages );
+ void ( *read_done ) ( FMAIFactoryObject *instance,
+ const FMAIFactoryProvider
*reader,
+ void *reader_data,
+ GSList **messages );
/**
* write_start:
@@ -216,7 +224,10 @@ typedef struct {
*
* Since: 2.30
*/
- guint ( *write_start )( FMAIFactoryObject *instance, const FMAIFactoryProvider *writer, void
*writer_data, GSList **messages );
+ guint ( *write_start )( FMAIFactoryObject *instance,
+ const FMAIFactoryProvider
*writer,
+ void *writer_data,
+ GSList **messages );
/**
* write_done:
@@ -232,7 +243,10 @@ typedef struct {
*
* Since: 2.30
*/
- guint ( *write_done ) ( FMAIFactoryObject *instance, const FMAIFactoryProvider *writer, void
*writer_data, GSList **messages );
+ guint ( *write_done ) ( FMAIFactoryObject *instance,
+ const FMAIFactoryProvider
*writer,
+ void *writer_data,
+ GSList **messages );
}
FMAIFactoryObjectInterface;
diff --git a/src/api/fma-ifactory-provider.h b/src/api/fma-ifactory-provider.h
index 21cc6f0..ef072a3 100644
--- a/src/api/fma-ifactory-provider.h
+++ b/src/api/fma-ifactory-provider.h
@@ -77,7 +77,7 @@
* <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.
+ * its properties in one single, centralized, place.
* </para>
* </formalpara>
* </listitem>
@@ -190,7 +190,10 @@ typedef struct {
*
* Since: 2.30
*/
- void ( *read_start ) ( const FMAIFactoryProvider *reader, void *reader_data, const
FMAIFactoryObject *object, GSList **messages );
+ void ( *read_start ) ( const FMAIFactoryProvider *reader,
+ void *reader_data,
+ const FMAIFactoryObject
*object,
+ GSList **messages );
/**
* read_data:
@@ -209,7 +212,11 @@ typedef struct {
*
* Since: 2.30
*/
- FMADataBoxed * ( *read_data ) ( const FMAIFactoryProvider *reader, void *reader_data, const
FMAIFactoryObject *object, const FMADataDef *def, GSList **messages );
+ FMADataBoxed * ( *read_data ) ( const FMAIFactoryProvider *reader,
+ void *reader_data,
+ const FMAIFactoryObject
*object,
+ const FMADataDef *def,
+ GSList **messages );
/**
* read_done:
@@ -225,7 +232,10 @@ typedef struct {
*
* Since: 2.30
*/
- void ( *read_done ) ( const FMAIFactoryProvider *reader, void *reader_data, const
FMAIFactoryObject *object, GSList **messages );
+ void ( *read_done ) ( const FMAIFactoryProvider *reader,
+ void *reader_data,
+ const FMAIFactoryObject
*object,
+ GSList **messages );
/**
* write_start:
@@ -241,7 +251,10 @@ typedef struct {
*
* Since: 2.30
*/
- guint ( *write_start )( const FMAIFactoryProvider *writer, void *writer_data, const
FMAIFactoryObject *object, GSList **messages );
+ guint ( *write_start )( const FMAIFactoryProvider *writer,
+ void *writer_data,
+ const FMAIFactoryObject
*object,
+ GSList **messages );
/**
* write_data:
@@ -261,7 +274,11 @@ typedef struct {
*
* Since: 2.30
*/
- guint ( *write_data ) ( const FMAIFactoryProvider *writer, void *writer_data, const
FMAIFactoryObject *object, const FMADataBoxed *boxed, GSList **messages );
+ guint ( *write_data ) ( const FMAIFactoryProvider *writer,
+ void *writer_data,
+ const FMAIFactoryObject
*object,
+ const FMADataBoxed *boxed,
+ GSList **messages );
/**
* write_done:
@@ -278,7 +295,10 @@ typedef struct {
*
* Since: 2.30
*/
- guint ( *write_done ) ( const FMAIFactoryProvider *writer, void *writer_data, const
FMAIFactoryObject *object, GSList **messages );
+ guint ( *write_done ) ( const FMAIFactoryProvider *writer,
+ void *writer_data,
+ const FMAIFactoryObject
*object,
+ GSList **messages );
}
FMAIFactoryProviderInterface;
diff --git a/src/api/fma-iimporter.h b/src/api/fma-iimporter.h
index ddc458a..6808792 100644
--- a/src/api/fma-iimporter.h
+++ b/src/api/fma-iimporter.h
@@ -154,7 +154,7 @@ typedef struct {
* @parms is supposed to map to FMAIImporterImportFromUriParms structure.
*
* Contrarily, if the provider implements the version 2 of the interface,
- * then @parms is supposed to map to a FMAIImporterImportFromUriParmsv2
+ * then @parms is expected to map to a FMAIImporterImportFromUriParmsv2
* structure.
*
* Return value: the return code of the operation.
@@ -183,7 +183,7 @@ typedef struct {
* should be systematically regenerated as a unique id, regardless of the
* asked import mode.
*
- * Standard N-A callers provide a function which checks for the existance
+ * Standard FMA callers provide a function which checks for the existance
* of the newly imported item :
* <itemizedlist>
* <listitem>
diff --git a/src/api/fma-iio-provider.h b/src/api/fma-iio-provider.h
index d689068..d5aec20 100644
--- a/src/api/fma-iio-provider.h
+++ b/src/api/fma-iio-provider.h
@@ -41,7 +41,7 @@
* to their own private storage subsystem.
*
* &prodname; core does not provide by itself input/output code. Instead,
- * we entirely relies on input/output facilities provided by implementations
+ * it entirely relies on input/output facilities provided by implementations
* of this interface.
*
* &prodname; is bundled with several I/O providers.
@@ -58,7 +58,7 @@
* loading items
* </title>
* <para>
- * Loading items is used both by the &nautilus; plugin, by the
+ * Loading items is used both by the file manager plugins, by the
* &fmact; program, and by the command-line utilities.
* </para>
* </formalpara>
@@ -77,7 +77,7 @@
* <listitem>
* <formalpara>
* <title>
- * informing &prodname; of extern modifications
+ * informing &prodname; of external modifications
* </title>
* <para>
* The I/O provider should inform &prodname; when an item happens to
@@ -85,13 +85,13 @@
* </para>
* </formalpara>
* <para>
- * This feature is only used by the &nautilus; plugin and by the
+ * This feature is only used by the file manager plugins and by the
* &fmact; program.
* </para>
* <para>
* The #FMAIIOProvider interface does not define specific monitoring
* methods (but you can also take a glance at #FMATimeout object).
- * Instead, it is waited that the I/O provider module takes care
+ * Instead, it is expected that the I/O provider module takes care
* itself of managing its own monitoring services at
* load/unload time, calling the fma_iio_provider_item_changed()
* function when appropriate.
@@ -128,12 +128,16 @@
* <colspec colname="label" />
* <colspec colname="holder" />
* <colspec colname="allocated" align="center" />
+ * <colspec colname="deprecated" />
+ * <colspec colname="current" />
* <thead>
* <row>
* <entry>Identifier</entry>
* <entry>Name</entry>
* <entry>Holder</entry>
* <entry>Allocated on</entry>
+ * <entry></entry>
+ * <entry></entry>
* </row>
* </thead>
* <tbody>
@@ -142,24 +146,56 @@
* <entry>Reserved for &prodname; internal needs</entry>
* <entry>&prodname;</entry>
* <entry>2010-01-28</entry>
+ * <entry></entry>
+ * <entry>current</entry>
+ * </row>
+ * <row>
+ * <entry><literal>na-desktop</literal></entry>
+ * <entry>NA Desktop I/O Provider</entry>
+ * <entry>&prodname;</entry>
+ * <entry>2009-12-16</entry>
+ * <entry>deprecated</entry>
+ * <entry></entry>
+ * </row>
+ * <row>
+ * <entry><literal>na-gconf</literal></entry>
+ * <entry>NA GConf I/O Provider</entry>
+ * <entry>&prodname;</entry>
+ * <entry>2009-12-16</entry>
+ * <entry>deprecated</entry>
+ * <entry></entry>
+ * </row>
+ * <row>
+ * <entry><literal>na-xml</literal></entry>
+ * <entry>NA XML module</entry>
+ * <entry>&prodname;</entry>
+ * <entry>2010-02-14</entry>
+ * <entry>deprecated</entry>
+ * <entry></entry>
* </row>
* <row>
* <entry><literal>io-desktop</literal></entry>
* <entry>FMA Desktop I/O Provider</entry>
* <entry>&prodname;</entry>
- * <entry>2009-12-16</entry>
+ * <entry>2015- 9-10</entry>
+ * <entry></entry>
+ * <entry>current</entry>
* </row>
* <row>
- * <entry><literal>fma-gconf</literal></entry>
+ * <entry><literal>io-gconf</literal></entry>
* <entry>FMA GConf I/O Provider</entry>
* <entry>&prodname;</entry>
- * <entry>2009-12-16</entry>
+ * <entry>2015- 9-10</entry>
+ * <entry>deprecated</entry>
+ * <entry></entry>
* </row>
* <row>
* <entry><literal>io-xml</literal></entry>
* <entry>FMA XML module</entry>
* <entry>&prodname;</entry>
- * <entry>2010-02-14</entry>
+ * <entry>2015- 9-10</entry>
+ * <entry></entry>
+ * <entry>current</entry>
* </row>
* </tbody>
* </tgroup>
@@ -297,7 +333,8 @@ typedef struct {
*
* Since: 2.30
*/
- GList * ( *read_items ) ( const FMAIIOProvider *instance, GSList **messages );
+ GList * ( *read_items ) ( const FMAIIOProvider *instance,
+ GSList **messages );
/**
* is_willing_to_write:
@@ -338,7 +375,7 @@ typedef struct {
* I/O provider is actually willing to write.
*
* This condition is only relevant when trying to define new items,
- * to see if a willing_to provider is actually able to do write
+ * to determine if a willing-to provider is actually able to do write
* operations. It it not relevant for updating/deleting already
* existing items as they have already checked their own runtime
* writability status when read from the storage subsystems.
@@ -379,7 +416,9 @@ typedef struct {
*
* Since: 2.30
*/
- guint ( *write_item ) ( const FMAIIOProvider *instance, const FMAObjectItem *item, GSList
**messages );
+ guint ( *write_item ) ( const FMAIIOProvider *instance,
+ const FMAObjectItem
*item,
+ GSList **messages );
/**
* delete_item:
@@ -398,7 +437,9 @@ typedef struct {
*
* Since: 2.30
*/
- guint ( *delete_item ) ( const FMAIIOProvider *instance, const FMAObjectItem *item, GSList
**messages );
+ guint ( *delete_item ) ( const FMAIIOProvider *instance,
+ const FMAObjectItem
*item,
+ GSList **messages );
/**
* duplicate_data:
@@ -423,7 +464,10 @@ typedef struct {
*
* Since: 2.30
*/
- guint ( *duplicate_data ) ( const FMAIIOProvider *instance, FMAObjectItem *dest, const
FMAObjectItem *source, GSList **messages );
+ guint ( *duplicate_data ) ( const FMAIIOProvider *instance,
+ FMAObjectItem *dest,
+ const FMAObjectItem
*source,
+ GSList **messages );
}
FMAIIOProviderInterface;
diff --git a/src/core/fma-data-boxed.c b/src/core/fma-data-boxed.c
index ae74ecc..7bed11e 100644
--- a/src/core/fma-data-boxed.c
+++ b/src/core/fma-data-boxed.c
@@ -319,9 +319,9 @@ fma_data_boxed_get_data_def( const FMADataBoxed *boxed )
* @boxed: this #FMADataBoxed object.
* @def: the new #FMADataDef to be set.
*
- * Changes the #FMADataDef a @boxed points to:
- * -> the new type must be the same that the previous one.
- * -> value is unchanged.
+ * Changes the #FMADataDef a @boxed points to.
+ * The new type must be the same that the previous one.
+ * The value is left unchanged.
*
* Since: 2.30
*/
@@ -497,8 +497,8 @@ fma_data_boxed_get_as_value( const FMADataBoxed *boxed, GValue *value )
*
* Returns: the content of the @boxed.
*
- * If of type NAFD_TYPE_STRING, NAFD_TYPE_LOCALE_STRING OR
- * NAFD_TYPE_STRING_LIST, then the content is returned in a newly
+ * If of type FMA_DATA_TYPE_STRING, FMA_DATA_TYPE_LOCALE_STRING OR
+ * FMA_DATA_TYPE_STRING_LIST, then the content is returned in a newly
* allocated value, which should be released by the caller.
*
* Since: 2.30
diff --git a/src/core/fma-iio-provider.c b/src/core/fma-iio-provider.c
index 592fb51..ae0a680 100644
--- a/src/core/fma-iio-provider.c
+++ b/src/core/fma-iio-provider.c
@@ -187,7 +187,7 @@ do_is_able_to_write( const FMAIIOProvider *instance )
* @instance: the calling #FMAIIOProvider.
*
* Informs &prodname; that this #FMAIIOProvider @instance has
- * detected a modification in (at least) one of its items (menu
+ * detected a modification in at least one of its items (menu
* or action).
*
* This function may be triggered for each and every
@@ -196,12 +196,12 @@ do_is_able_to_write( const FMAIIOProvider *instance )
*
* When receiving this signal, the currently running program may just
* want to immediately reload the current list of items, menus and actions
- * (this is for example what &nautilus; plugin does); it may also choose
- * to ask the user if he is willing to reload such a current list (and
- * this is the way &fmact; has chosen to deal with this message).
+ * (this is for example what the file manager plugins do); it may also
+ * choose to ask the user if he is willing to reload such a current list
+ * (and this is the way &fmact; has chosen to deal with this message).
*
- * Note that application FMAPivot/FMAUpdater pivot is typically the only
- * object connected to this signal. It acts so as a filtering proxy,
+ * Note that application FMAPivot/FMAUpdater pivot is typically the
+ * only object connected to this signal. It acts so as a filtering proxy,
* re-emitting its own 'items-changed' signal for a whole set of detected
* underlying modifications.
*
diff --git a/src/core/fma-importer.h b/src/core/fma-importer.h
index bb85b6c..d8bf460 100644
--- a/src/core/fma-importer.h
+++ b/src/core/fma-importer.h
@@ -78,7 +78,7 @@ G_BEGIN_DECLS
* Since: 3.2
*
* This same enum used to be defined as FMAIImporterImportMode in api/fma-iimporter.h
- * header. The enum has been deprecated there in N-A 3.2 when the FMAIImporter v2
+ * header. The enum has been deprecated there in FMA 3.2 when the FMAIImporter v2
* interface was defined. It has so been moved here with the FMAImporterImportMode
* name.
*/
diff --git a/src/core/fma-object.c b/src/core/fma-object.c
index 616de56..eee2782 100644
--- a/src/core/fma-object.c
+++ b/src/core/fma-object.c
@@ -636,11 +636,11 @@ fma_object_object_ref( FMAObject *object )
* @object: a #FMAObject -derived object.
*
* Recursively unref the @object and all its children, decrementing their
- * reference_count by 1.
+ * reference count by 1.
*
- * Note that we may want to free a copy+ref of a list of items whichy have
+ * Note that we may want to free a copy+ref of a list of items which have
* had already disposed (which is probably a bug somewhere). So first test
- * is the object is still alive.
+ * is to determine if the object is still alive.
*
* Since: 2.30
*/
diff --git a/src/core/fma-pivot.h b/src/core/fma-pivot.h
index e8abb51..36dcacb 100644
--- a/src/core/fma-pivot.h
+++ b/src/core/fma-pivot.h
@@ -124,7 +124,7 @@ GType fma_pivot_get_type( void );
/* Loadable population
* NACT management user interface defaults to PIVOT_LOAD_ALL
- * N-A plugin set the loadable population to !PIVOT_LOAD_DISABLED & !PIVOT_LOAD_INVALID
+ * FMA plugin set the loadable population to !PIVOT_LOAD_DISABLED & !PIVOT_LOAD_INVALID
*/
typedef enum {
PIVOT_LOAD_NONE = 0,
diff --git a/src/io-desktop/fma-desktop-reader.c b/src/io-desktop/fma-desktop-reader.c
index 2fba8c9..f717fd1 100644
--- a/src/io-desktop/fma-desktop-reader.c
+++ b/src/io-desktop/fma-desktop-reader.c
@@ -143,7 +143,7 @@ get_list_of_desktop_paths( FMADesktopProvider *provider, GSList **messages )
*/
for( idir = xdg_dirs ; idir ; idir = idir->next ){
- /* explore each N-A candidate subdirectory for each XDG dir
+ /* explore each FMA candidate subdirectory for each XDG dir
*/
for( isub = subdirs ; isub ; isub = isub->next ){
@@ -357,7 +357,7 @@ free_desktop_paths( GList *paths )
* So we have to load the file into memory, and then try to load the key
* file from the memory data.
*
- * Starting with N-A 3.2, we only honor the version 2 of #FMAIImporter interface,
+ * Starting with FMA 3.2, we only honor the version 2 of #FMAIImporter interface,
* thus no more checking here against possible duplicate identifiers.
*/
guint
diff --git a/src/io-xml/fma-xml-reader.c b/src/io-xml/fma-xml-reader.c
index 9a54452..c3b2462 100644
--- a/src/io-xml/fma-xml-reader.c
+++ b/src/io-xml/fma-xml-reader.c
@@ -316,7 +316,7 @@ reader_new( void )
* then we do not return any error message at all, but just the 'unwilling to'
* code.
*
- * Starting with N-A 3.2, we only honor the version 2 of #FMAIImporter interface,
+ * Starting with FMA 3.2, we only honor the version 2 of #FMAIImporter interface,
* thus no more checking here against possible duplicate identifiers.
*/
guint
diff --git a/src/plugin-menu/fma-menu-module.c b/src/plugin-menu/fma-menu-module.c
index 5fadfb2..b2db62e 100644
--- a/src/plugin-menu/fma-menu-module.c
+++ b/src/plugin-menu/fma-menu-module.c
@@ -154,7 +154,7 @@ set_log_handler( void )
* we used to install a log handler for each and every log domain used
* in FileManager-Actions ; this led to a fastidious enumeration
* instead we install a default log handler which will receive all
- * debug messages, i.e. not only from N-A, but also from other code
+ * debug messages, i.e. not only from FMA, but also from other code
* in the Nautilus process
*/
static void
diff --git a/src/plugin-tracker/fma-tracker-module.c b/src/plugin-tracker/fma-tracker-module.c
index ee7ffbb..20f9600 100644
--- a/src/plugin-tracker/fma-tracker-module.c
+++ b/src/plugin-tracker/fma-tracker-module.c
@@ -130,7 +130,7 @@ set_log_handler( void )
* we used to install a log handler for each and every log domain used
* in FileManager-Actions ; this led to a fastidious enumeration
* instead we install a default log handler which will receive all
- * debug messages, i.e. not only from N-A, but also from other code
+ * debug messages, i.e. not only from FMA, but also from other code
* in the Nautilus process
*/
static void
diff --git a/src/utils/fma-gconf2key.sh.in b/src/utils/fma-gconf2key.sh.in
index d0d797d..e2874e0 100644
--- a/src/utils/fma-gconf2key.sh.in
+++ b/src/utils/fma-gconf2key.sh.in
@@ -689,7 +689,7 @@ writable = false
let nbprefs=0
if [ -e ${destconf} ]; then
- msg "${destconf} already exists: do not replace it, update the N-A configuration file instead"
+ msg "${destconf} already exists: do not replace it, update the FMA configuration file instead"
command "@pkglibexecdir@/fma-set-conf --group 'io-provider fma-gconf' --key writable --type bool
--value false"
else
nbprefs=$(cat ${my_tmproot}.nact ${my_tmproot}.runtime ${my_tmproot}.io-provider_* 2>/dev/null | wc
-l)
diff --git a/src/utils/fma-set-conf.c b/src/utils/fma-set-conf.c
index 3852a26..fc3ecf5 100644
--- a/src/utils/fma-set-conf.c
+++ b/src/utils/fma-set-conf.c
@@ -42,7 +42,7 @@
#include "console-utils.h"
/*
- * A program to update the N-A configuration files
+ * A program to update the FMA configuration files
*/
#include <core/fma-settings.h>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
