Doc fixes in both source comments and gtk-doc files

This commit is contained in:
Michael Natterer
2011-11-25 21:39:55 +01:00
parent c08a47c5e5
commit ebbad40885
16 changed files with 90 additions and 22 deletions

View File

@ -563,22 +563,22 @@ gimp_quit (void)
* "*" for all image types. If the procedure doesn't need an image to
* run, use the empty string.
*
* @type must be one of #GIMP_PLUGIN or #GIMP_EXTENSION. Note that
* @type must be one of %GIMP_PLUGIN or %GIMP_EXTENSION. Note that
* temporary procedures must be installed using
* gimp_install_temp_proc().
*
* NOTE: Unlike the GIMP 1.2 API, #GIMP_EXTENSION no longer means
* NOTE: Unlike the GIMP 1.2 API, %GIMP_EXTENSION no longer means
* that the procedure's menu prefix is <Toolbox>, but that
* it will install temporary procedures. Therefore, the GIMP core
* will wait until the #GIMP_EXTENSION procedure has called
* will wait until the %GIMP_EXTENSION procedure has called
* gimp_extension_ack(), which means that the procedure has done
* its initialization, installed its temporary procedures and is
* ready to run.
*
* <emphasis>Not calling gimp_extension_ack() from a #GIMP_EXTENSION
* <emphasis>Not calling gimp_extension_ack() from a %GIMP_EXTENSION
* procedure will cause the GIMP core to lock up.</emphasis>
*
* Additionally, a #GIMP_EXTENSION procedure with no parameters
* Additionally, a %GIMP_EXTENSION procedure with no parameters
* (@n_params == 0 and @params == #NULL) is an "automatic" extension
* that will be automatically started on each GIMP startup.
**/
@ -650,7 +650,7 @@ gimp_install_procedure (const gchar *name,
*
* See gimp_install_procedure() for most details.
*
* @type <emphasis>must</emphasis> be #GIMP_TEMPORARY or the function
* @type <emphasis>must</emphasis> be %GIMP_TEMPORARY or the function
* will fail.
*
* @run_proc is the function which will be called to execute the
@ -733,12 +733,12 @@ gimp_uninstall_temp_proc (const gchar *name)
* gimp_run_procedure:
* @name: the name of the procedure to run
* @n_return_vals: return location for the number of return values
* @Varargs: list of procedure parameters
* @...: list of procedure parameters
*
* This function calls a GIMP procedure and returns its return values.
*
* The procedure's parameters are given by a va_list in the format
* (type, value, type, value) and must be terminated by #GIMP_PDB_END.
* (type, value, type, value) and must be terminated by %GIMP_PDB_END.
*
* This function converts the va_list of parameters into an array and
* passes them to gimp_run_procedure2(). Please look there for further

View File

@ -597,7 +597,7 @@ gimp_drawable_parasite_detach (gint32 drawable_ID,
* @num_parasites: The number of attached parasites.
* @parasites: The names of currently attached parasites.
*
* Deprecated: Use gimp_item_list_parasites() instead.
* Deprecated: Use gimp_item_get_parasite_list() instead.
*
* Returns: TRUE on success.
**/

View File

@ -675,7 +675,7 @@ export_dialog (GSList *actions,
* and drawable_ID is not altered, GIMP_EXPORT_IGNORE is returned and
* the save_plugin should try to save the original image. If the
* user chooses Cancel, GIMP_EXPORT_CANCEL is returned and the
* save_plugin should quit itself with status #GIMP_PDB_CANCEL.
* save_plugin should quit itself with status %GIMP_PDB_CANCEL.
*
* If @format_name is NULL, no dialogs will be shown and this function
* will behave as if the user clicked on the 'Export' button, if a

View File

@ -712,8 +712,8 @@ gimp_pixel_rgns_register2 (gint nrgns,
/**
* gimp_pixel_rgns_register:
* @nrgns: the number of regions to register.
* @Varargs: @nrgns pointers to #GimpPixelRgn.
* @nrgns: the number of regions to register.
* @...: @nrgns pointers to #GimpPixelRgn.
*
* This is the varargs version of #gimp_pixel_rgns_register2.
*

View File

@ -242,7 +242,7 @@ gimp_progress_init (const gchar *message)
/**
* gimp_progress_init_printf:
* @format: a standard printf() format string
* @Varargs: arguments for @format
* @...: arguments for @format
*
* Initializes the progress bar for the current plug-in.
*
@ -277,7 +277,7 @@ gimp_progress_init_printf (const gchar *format,
/**
* gimp_progress_set_text_printf:
* @format: a standard printf() format string
* @Varargs: arguments for @format
* @...: arguments for @format
*
* Changes the text in the progress bar for the current plug-in.
*

View File

@ -256,7 +256,7 @@ gimp_vectors_parasite_detach (gint32 vectors_ID,
* @num_parasites: The number of attached parasites.
* @parasites: The names of currently attached parasites.
*
* Deprecated: Use gimp_item_list_parasites() instead.
* Deprecated: Use gimp_item_get_parasite_list() instead.
*
* Returns: TRUE on success.
*