From 26dd492af6580330cd6a893717a237d47a3efd01 Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Wed, 17 Jan 2001 22:31:35 +0000 Subject: Use "typedef enum { ... } Blah;" instead of "typedef enum _Blah Blah; enum 2001-01-17 Federico Mena Quintero * 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 --- .../importer/tmpl/evolution-importer-client.sgml | 22 +++---- doc/devel/importer/tmpl/evolution-importer.sgml | 67 +++++++++++----------- 2 files changed, 41 insertions(+), 48 deletions(-) (limited to 'doc/devel/importer/tmpl') diff --git a/doc/devel/importer/tmpl/evolution-importer-client.sgml b/doc/devel/importer/tmpl/evolution-importer-client.sgml index 8e911a91dd..ac1718dc7e 100644 --- a/doc/devel/importer/tmpl/evolution-importer-client.sgml +++ b/doc/devel/importer/tmpl/evolution-importer-client.sgml @@ -2,14 +2,11 @@ EvolutionImporterClient -GTK+ object for communication with importer components. + - 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. + @@ -19,22 +16,21 @@ GTK+ object for communication with importer components. - Casts a #GtkObject into an #EvolutionImporterClient + -@obj: A GtkObject. +@obj: - The type of the function that will be called when the importer has something - to report to the shell. + -@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: diff --git a/doc/devel/importer/tmpl/evolution-importer.sgml b/doc/devel/importer/tmpl/evolution-importer.sgml index 06aa2ea762..a1c7160eae 100644 --- a/doc/devel/importer/tmpl/evolution-importer.sgml +++ b/doc/devel/importer/tmpl/evolution-importer.sgml @@ -2,13 +2,11 @@ EvolutionImporter -GTK+ object used to create Evolution Importers . + - The #EvolutionImporter object provides a GTK+ wrapper for the CORBA - interface that is used to communicate between the importer and the - Evolution shell. + @@ -18,70 +16,69 @@ GTK+ object used to create Evolution Importers . - Casts a #GtkObject to an #EvolutionImporter + -@obj: A GTK+ object. +@obj: - The function that is called when the Evolution shell wants to know - whether this #EvolutionImporter is able to support the file specified - by @filename. + -@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: - The function that is called when the Evolution shell wants the - #EvolutionImporter to load a file. + -@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: - The function that is called when the Evolution shell wants the - #EvolutionImporter to process the next item in the file. - - - This function may process one item, or it may process as many as it - wants/is able to. -@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: - The function that is called when the Evolution shell wants to find out - about any errors that may have occurred. + -@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: - These values describe the result of the processItem CORBA method. + +@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: -- cgit v1.2.3