diff options
author | Federico Mena Quintero <federico@ximian.com> | 2001-01-18 06:31:35 +0800 |
---|---|---|
committer | Federico Mena Quintero <federico@src.gnome.org> | 2001-01-18 06:31:35 +0800 |
commit | 26dd492af6580330cd6a893717a237d47a3efd01 (patch) | |
tree | 4decae5704def785324ea79faf641bbb222528d4 | |
parent | 1a6bb41b0df656a29274da049e5fff924859d76f (diff) | |
download | gsoc2013-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
-rw-r--r-- | doc/devel/calendar/cal-util/evolution-cal-util-decl.txt | 5 | ||||
-rw-r--r-- | doc/devel/importer/evolution-shell-importer.hierarchy | 3 | ||||
-rw-r--r-- | doc/devel/importer/tmpl/evolution-importer-client.sgml | 22 | ||||
-rw-r--r-- | doc/devel/importer/tmpl/evolution-importer.sgml | 67 | ||||
-rw-r--r-- | help/devel/calendar/cal-util/evolution-cal-util-decl.txt | 5 | ||||
-rw-r--r-- | help/devel/importer/evolution-shell-importer.hierarchy | 3 | ||||
-rw-r--r-- | help/devel/importer/tmpl/evolution-importer-client.sgml | 22 | ||||
-rw-r--r-- | help/devel/importer/tmpl/evolution-importer.sgml | 67 | ||||
-rw-r--r-- | shell/ChangeLog | 6 | ||||
-rw-r--r-- | shell/importer/evolution-importer.h | 5 |
10 files changed, 100 insertions, 105 deletions
diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt index 573ce73a65..114129515b 100644 --- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -472,6 +472,11 @@ CalComponent *comp, const char **url CalComponent *comp, const char *url </FUNCTION> <FUNCTION> +<NAME>cal_component_event_dates_match</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp1, CalComponent *comp2 +</FUNCTION> +<FUNCTION> <NAME>cal_component_free_categories_list</NAME> <RETURNS>void </RETURNS> GSList *categ_list diff --git a/doc/devel/importer/evolution-shell-importer.hierarchy b/doc/devel/importer/evolution-shell-importer.hierarchy index 239d0026e0..550c81c298 100644 --- a/doc/devel/importer/evolution-shell-importer.hierarchy +++ b/doc/devel/importer/evolution-shell-importer.hierarchy @@ -1,7 +1,4 @@ GtkObject - GtkWidget - GtkRange - GtkContainer BonoboObject EvolutionImporter Handle to remote Bonobo::Unknown 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 <!-- ##### 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/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 <!-- ##### 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> diff --git a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt index 573ce73a65..114129515b 100644 --- a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -472,6 +472,11 @@ CalComponent *comp, const char **url CalComponent *comp, const char *url </FUNCTION> <FUNCTION> +<NAME>cal_component_event_dates_match</NAME> +<RETURNS>gboolean </RETURNS> +CalComponent *comp1, CalComponent *comp2 +</FUNCTION> +<FUNCTION> <NAME>cal_component_free_categories_list</NAME> <RETURNS>void </RETURNS> GSList *categ_list 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> diff --git a/shell/ChangeLog b/shell/ChangeLog index 0db4d162da..6190823c12 100644 --- a/shell/ChangeLog +++ b/shell/ChangeLog @@ -1,3 +1,9 @@ +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. + 2001-01-17 Ettore Perazzoli <ettore@ximian.com> * e-shell-folder-selection-dialog.c diff --git a/shell/importer/evolution-importer.h b/shell/importer/evolution-importer.h index 6842438417..fa5c944c2c 100644 --- a/shell/importer/evolution-importer.h +++ b/shell/importer/evolution-importer.h @@ -40,7 +40,6 @@ extern "C" { typedef struct _EvolutionImporter EvolutionImporter; typedef struct _EvolutionImporterPrivate EvolutionImporterPrivate; typedef struct _EvolutionImporterClass EvolutionImporterClass; -typedef enum _EvolutionImporterResult EvolutionImporterResult; typedef gboolean (* EvolutionImporterSupportFormatFn) (EvolutionImporter *importer, const char *filename, @@ -55,7 +54,7 @@ typedef void (* EvolutionImporterProcessItemFn) (EvolutionImporter *importer, typedef char *(* EvolutionImporterGetErrorFn) (EvolutionImporter *importer, void *closure); -enum _EvolutionImporterResult { +typedef enum { EVOLUTION_IMPORTER_OK, EVOLUTION_IMPORTER_UNSUPPORTED_OPERATION, EVOLUTION_IMPORTER_INTERRUPTED, @@ -65,7 +64,7 @@ enum _EvolutionImporterResult { EVOLUTION_IMPORTER_BAD_DATA, EVOLUTION_IMPORTER_BAD_FILE, EVOLUTION_IMPORTER_UNKNOWN_ERROR -}; +} EvolutionImporterResult; struct _EvolutionImporter { BonoboObject parent; |