procyberian/gimp
2
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/gimp.git synced 2025-07-03 17:33:25 +00:00
Code Issues 1 Projects 1 Releases Packages Wiki Activity Actions

pdb, libgimp: fix various doc issues found by gtk-doc

Browse source
This commit is contained in:
Michael Natterer 2019-08-10 11:08:06 +02:00
parent 7e504a0ddd
commit 60b6f34737
5 changed files with 17 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

4
libgimp/gimp_pdb.c
View file

@ -26,8 +26,8 @@
/**
* SECTION: Gimp
* @title: Gimp
* SECTION: gimp
* @title: gimp
* @short_description: Main functions needed for building a GIMP plug-in.
*
* Main functions needed for building a GIMP plug-in.

2
libgimp/gimplegacy.c
View file

@ -1335,7 +1335,7 @@ gimp_pdb_proc_exists (const gchar *procedure_name)
/**
* gimp_pdb_proc_info:
* @procedure: The procedure name.
* @procedure_name: The procedure name.
* @blurb: A short blurb.
* @help: Detailed procedure help.
* @author: Author(s) of the procedure.

6
libgimp/gimpplugin.c
View file

@ -530,7 +530,7 @@ gimp_plug_in_extension_enable (GimpPlugIn *plug_in)
* Processes one message sent by GIMP and returns.
*
* Call this function in an endless loop after calling
* gimp_plug_in_extension_ready() to process requests for running
* gimp_procedure_extension_ready() to process requests for running
* temporary procedures.
*
* See gimp_plug_in_extension_enable() for an asynchronous way of
@ -606,7 +606,7 @@ gimp_plug_in_extension_process (GimpPlugIn *plug_in,
}
/**
* gimp_plugin_set_pdb_error_handler:
* gimp_plug_in_set_pdb_error_handler:
* @plug_in: A #GimpPlugIn
* @handler: Who is responsible for handling procedure call errors.
*
@ -633,7 +633,7 @@ gimp_plug_in_set_pdb_error_handler (GimpPlugIn *plug_in,
}
/**
* gimp_plugin_get_pdb_error_handler:
* gimp_plug_in_get_pdb_error_handler:
* @plug_in: A #GimpPlugIn
*
* Retrieves the active error handler for procedure calls.

9
libgimp/gimpprocedure.c
View file

@ -305,7 +305,7 @@ gimp_procedure_real_run (GimpProcedure *procedure,
* has done its initialization, installed its temporary procedures and
* is ready to run.
*
* <emphasis>Not calling gimp_procedure_extension_reads() from a
* <emphasis>Not calling gimp_procedure_extension_ready() from a
* %GIMP_EXTENSION procedure will cause the GIMP core to lock
* up.</emphasis>
*
@ -404,7 +404,8 @@ gimp_procedure_get_proc_type (GimpProcedure *procedure)
/**
* gimp_procedure_set_image_types:
* @image_types the image types this procedure can operate on.
* @procedure: A #GimpProcedure.
* @image_types: The image types this procedure can operate on.
*
* This is a comma separated list of image types, or actually drawable
* types, that this procedure can deal with. Wildcards are possible
@ -428,8 +429,9 @@ gimp_procedure_set_image_types (GimpProcedure *procedure,
/**
* gimp_procedure_get_image_types:
* @procedure: A #GimpProcedure.
*
* This procedure retrieves the list of image types the procedure can
* This function retrieves the list of image types the procedure can
* operate on. See gimp_procedure_set_image_types().
*
* Returns: The image types.
@ -1218,6 +1220,7 @@ gimp_procedure_run (GimpProcedure *procedure,
/**
* gimp_procedure_extension_ready:
* @procedure: A #GimpProcedure
*
* Notify the main GIMP application that the extension has been
* properly initialized and is ready to run.

9
pdb/groups/gimp.pdb
View file

@ -189,6 +189,7 @@ sub get_parasite_list {
CODE
);
}
sub temp_name {
$blurb = 'Generates a unique filename.';
@ -229,16 +230,16 @@ CODE
@procs = qw(version
getpid
quit
attach_parasite detach_parasite
attach_parasite
detach_parasite
get_parasite
get_parasite_list
temp_name);
%exports = (app => [@procs], lib => [@procs[0..1,3..7]]);
$desc = 'Miscellaneous';
$doc_title = 'Gimp';
$desc = 'Gimp';
$doc_title = 'gimp';
$doc_short_desc = 'Main functions needed for building a GIMP plug-in.';
$doc_long_desc = <<'DESC';
Main functions needed for building a GIMP plug-in.