aboutsummaryrefslogtreecommitdiffstats
path: root/help/devel/importer
diff options
context:
space:
mode:
authorFederico Mena Quintero <federico@ximian.com>2001-01-18 06:31:35 +0800
committerFederico Mena Quintero <federico@src.gnome.org>2001-01-18 06:31:35 +0800
commit26dd492af6580330cd6a893717a237d47a3efd01 (patch)
tree4decae5704def785324ea79faf641bbb222528d4 /help/devel/importer
parent1a6bb41b0df656a29274da049e5fff924859d76f (diff)
downloadgsoc2013-evolution-26dd492af6580330cd6a893717a237d47a3efd01.tar
gsoc2013-evolution-26dd492af6580330cd6a893717a237d47a3efd01.tar.gz
gsoc2013-evolution-26dd492af6580330cd6a893717a237d47a3efd01.tar.bz2
gsoc2013-evolution-26dd492af6580330cd6a893717a237d47a3efd01.tar.lz
gsoc2013-evolution-26dd492af6580330cd6a893717a237d47a3efd01.tar.xz
gsoc2013-evolution-26dd492af6580330cd6a893717a237d47a3efd01.tar.zst
gsoc2013-evolution-26dd492af6580330cd6a893717a237d47a3efd01.zip
Use "typedef enum { ... } Blah;" instead of "typedef enum _Blah Blah; enum
2001-01-17 Federico Mena Quintero <federico@ximian.com> * importer/evolution-importer.h: Use "typedef enum { ... } Blah;" instead of "typedef enum _Blah Blah; enum _Blah { ... };" so that gtk-doc can parse it. Sigh. svn path=/trunk/; revision=7600
Diffstat (limited to 'help/devel/importer')
-rw-r--r--help/devel/importer/evolution-shell-importer.hierarchy3
-rw-r--r--help/devel/importer/tmpl/evolution-importer-client.sgml22
-rw-r--r--help/devel/importer/tmpl/evolution-importer.sgml67
3 files changed, 41 insertions, 51 deletions
diff --git a/help/devel/importer/evolution-shell-importer.hierarchy b/help/devel/importer/evolution-shell-importer.hierarchy
index 239d0026e0..550c81c298 100644
--- a/help/devel/importer/evolution-shell-importer.hierarchy
+++ b/help/devel/importer/evolution-shell-importer.hierarchy
@@ -1,7 +1,4 @@
GtkObject
- GtkWidget
- GtkRange
- GtkContainer
BonoboObject
EvolutionImporter
Handle to remote Bonobo::Unknown
diff --git a/help/devel/importer/tmpl/evolution-importer-client.sgml b/help/devel/importer/tmpl/evolution-importer-client.sgml
index 8e911a91dd..ac1718dc7e 100644
--- a/help/devel/importer/tmpl/evolution-importer-client.sgml
+++ b/help/devel/importer/tmpl/evolution-importer-client.sgml
@@ -2,14 +2,11 @@
EvolutionImporterClient
<!-- ##### SECTION Short_Description ##### -->
-GTK+ object for communication with importer components.
+
<!-- ##### SECTION Long_Description ##### -->
<para>
- The #EvolutionImporterClient provides a GTK+ wrapper for the CORBA
- interfaces that are used to communicate between the shell and the
- importers. The #EvolutionImporterClient removes the need for CORBA
- calls in the shell.
+
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -19,22 +16,21 @@ GTK+ object for communication with importer components.
<!-- ##### MACRO EVOLUTION_IMPORTER_CLIENT ##### -->
<para>
- Casts a #GtkObject into an #EvolutionImporterClient
+
</para>
-@obj: A GtkObject.
+@obj:
<!-- ##### USER_FUNCTION EvolutionImporterClientCallback ##### -->
<para>
- The type of the function that will be called when the importer has something
- to report to the shell.
+
</para>
-@client: An #EvolutionImporterClient object.
-@result: An #EvolutionImporterResult describing the result of the action.
-@more_items: A #gboolean indicating whether there are any more items to be processed.
-@data: The data that was passed into evolution_importer_client_process_item().
+@client:
+@result:
+@more_items:
+@data:
<!-- ##### FUNCTION evolution_importer_client_new ##### -->
diff --git a/help/devel/importer/tmpl/evolution-importer.sgml b/help/devel/importer/tmpl/evolution-importer.sgml
index 06aa2ea762..a1c7160eae 100644
--- a/help/devel/importer/tmpl/evolution-importer.sgml
+++ b/help/devel/importer/tmpl/evolution-importer.sgml
@@ -2,13 +2,11 @@
EvolutionImporter
<!-- ##### SECTION Short_Description ##### -->
-GTK+ object used to create Evolution Importers .
+
<!-- ##### SECTION Long_Description ##### -->
<para>
- The #EvolutionImporter object provides a GTK+ wrapper for the CORBA
- interface that is used to communicate between the importer and the
- Evolution shell.
+
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -18,70 +16,69 @@ GTK+ object used to create Evolution Importers .
<!-- ##### MACRO EVOLUTION_IMPORTER ##### -->
<para>
- Casts a #GtkObject to an #EvolutionImporter
+
</para>
-@obj: A GTK+ object.
+@obj:
<!-- ##### USER_FUNCTION EvolutionImporterSupportFormatFn ##### -->
<para>
- The function that is called when the Evolution shell wants to know
- whether this #EvolutionImporter is able to support the file specified
- by @filename.
+
</para>
-@importer: An #EvolutionImporter object.
-@filename: The name of file to check.
-@closure: The data that was passed into evolution_importer_new ().
-@Returns: #TRUE if the importer can handle the file, #FALSE otherwise
+@importer:
+@filename:
+@closure:
+@Returns:
<!-- ##### USER_FUNCTION EvolutionImporterLoadFileFn ##### -->
<para>
- The function that is called when the Evolution shell wants the
- #EvolutionImporter to load a file.
+
</para>
-@importer: An #EvolutionImporter object.
-@filename: The name of the file to load.
-@closure: The data that was passed into evolution_importer_new ().
-@Returns: #TRUE on success, #FALSE otherwise.
+@importer:
+@filename:
+@closure:
+@Returns:
<!-- ##### USER_FUNCTION EvolutionImporterProcessItemFn ##### -->
<para>
- The function that is called when the Evolution shell wants the
- #EvolutionImporter to process the next item in the file.
-</para>
-<para>
- This function may process one item, or it may process as many as it
- wants/is able to.
</para>
-@importer: An #EvolutionImporter object.
-@listener: A #CORBA_Object that will be informed of the results.
-@closure: The data that was passed into evolution_importer_new ().
-@ev: A #CORBA_Environment for returning any CORBA exceptions that may occur.
+@importer:
+@listener:
+@closure:
+@ev:
<!-- ##### USER_FUNCTION EvolutionImporterGetErrorFn ##### -->
<para>
- The function that is called when the Evolution shell wants to find out
- about any errors that may have occurred.
+
</para>
-@importer: An #EvolutionImporter object.
-@closure: The data that was passed into evolution_importer_new ().
-@Returns: A string with the error message, or #NULL if there was none.
+@importer:
+@closure:
+@Returns:
<!-- ##### ENUM EvolutionImporterResult ##### -->
<para>
- These values describe the result of the processItem CORBA method.
+
</para>
+@EVOLUTION_IMPORTER_OK:
+@EVOLUTION_IMPORTER_UNSUPPORTED_OPERATION:
+@EVOLUTION_IMPORTER_INTERRUPTED:
+@EVOLUTION_IMPORTER_BUSY:
+@EVOLUTION_IMPORTER_NOT_READY:
+@EVOLUTION_IMPORTER_UNKNOWN_DATA:
+@EVOLUTION_IMPORTER_BAD_DATA:
+@EVOLUTION_IMPORTER_BAD_FILE:
+@EVOLUTION_IMPORTER_UNKNOWN_ERROR:
<!-- ##### FUNCTION evolution_importer_new ##### -->
<para>