diff --git a/libgimp/gimpbrush_pdb.c b/libgimp/gimpbrush_pdb.c index 79a0f446ce..6c0d123d4d 100644 --- a/libgimp/gimpbrush_pdb.c +++ b/libgimp/gimpbrush_pdb.c @@ -26,6 +26,16 @@ #include "gimp.h" + +/** + * SECTION: gimpbrush + * @title: gimpbrush + * @short_description: Functions operating on a single brush. + * + * Functions operating on a single brush. + **/ + + /** * gimp_brush_new: * @name: The requested name of the new brush. diff --git a/libgimp/gimpbrushes_pdb.c b/libgimp/gimpbrushes_pdb.c index b81f04cca3..88f8e1ee5b 100644 --- a/libgimp/gimpbrushes_pdb.c +++ b/libgimp/gimpbrushes_pdb.c @@ -29,6 +29,16 @@ #undef __GIMP_BRUSHES_PDB_H__ #include "gimpbrushes_pdb.h" + +/** + * SECTION: gimpbrushes + * @title: gimpbrushes + * @short_description: Functions for manipulating brushes. + * + * Functions related to getting and setting brushes. + **/ + + /** * gimp_brushes_refresh: * diff --git a/libgimp/gimpbrushselect_pdb.c b/libgimp/gimpbrushselect_pdb.c index 154e22d860..4226df1811 100644 --- a/libgimp/gimpbrushselect_pdb.c +++ b/libgimp/gimpbrushselect_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpbrushselect + * @title: gimpbrushselect + * @short_description: Functions providing a brush selection dialog. + * + * Functions providing a brush selection dialog. + **/ + + /** * gimp_brushes_popup: * @brush_callback: The callback PDB proc to call when brush selection is made. diff --git a/libgimp/gimpbuffer_pdb.c b/libgimp/gimpbuffer_pdb.c index 017670c5d7..1edf7560a7 100644 --- a/libgimp/gimpbuffer_pdb.c +++ b/libgimp/gimpbuffer_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpbuffer + * @title: gimpbuffer + * @short_description: Functions for manipulating cut buffers. + * + * Functions related to named cut buffers. + **/ + + /** * gimp_buffers_get_list: * @filter: An optional regular expression used to filter the list. diff --git a/libgimp/gimpchannel_pdb.c b/libgimp/gimpchannel_pdb.c index cbe506fee0..d4ee0c6e22 100644 --- a/libgimp/gimpchannel_pdb.c +++ b/libgimp/gimpchannel_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpchannel + * @title: gimpchannel + * @short_description: Functions for manipulating channels. + * + * Functions for manipulating channels. + **/ + + /** * _gimp_channel_new: * @image_ID: The image to which to add the channel. diff --git a/libgimp/gimpcolor_pdb.c b/libgimp/gimpcolor_pdb.c index fc6912d4fa..3365f6485b 100644 --- a/libgimp/gimpcolor_pdb.c +++ b/libgimp/gimpcolor_pdb.c @@ -27,6 +27,16 @@ #undef __GIMP_COLOR_PDB_H__ #include "gimpcolor_pdb.h" + +/** + * SECTION: gimpcolor + * @title: gimpcolor + * @short_description: Functions for manipulating color. + * + * Functions for manipulating color, including curves and histograms. + **/ + + /** * gimp_brightness_contrast: * @drawable_ID: The drawable. diff --git a/libgimp/gimpcontext_pdb.c b/libgimp/gimpcontext_pdb.c index dd260bdcba..49de4f1262 100644 --- a/libgimp/gimpcontext_pdb.c +++ b/libgimp/gimpcontext_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpcontext + * @title: gimpcontext + * @short_description: Functions to manipulate a plug-in's context. + * + * Functions to manipulate a plug-in's context. + **/ + + /** * gimp_context_push: * diff --git a/libgimp/gimpconvert_pdb.c b/libgimp/gimpconvert_pdb.c index 0e3980be89..0eada4cc44 100644 --- a/libgimp/gimpconvert_pdb.c +++ b/libgimp/gimpconvert_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpconvert + * @title: gimpconvert + * @short_description: Conversions between RGB, indexed, and grayscale modes. + * + * Conversions between RGB, indexed, and grayscale modes. + **/ + + /** * gimp_image_convert_rgb: * @image_ID: The image. diff --git a/libgimp/gimpdisplay_pdb.c b/libgimp/gimpdisplay_pdb.c index 845600f551..fb6a21d13a 100644 --- a/libgimp/gimpdisplay_pdb.c +++ b/libgimp/gimpdisplay_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpdisplay + * @title: gimpdisplay + * @short_description: Functions to create, delete and flush displays (views) on an image. + * + * Functions to create, delete and flush displays (views) on an image. + **/ + + /** * gimp_display_is_valid: * @display_ID: The display to check. diff --git a/libgimp/gimpdrawable_pdb.c b/libgimp/gimpdrawable_pdb.c index 6727504520..5e27bcb43b 100644 --- a/libgimp/gimpdrawable_pdb.c +++ b/libgimp/gimpdrawable_pdb.c @@ -29,6 +29,16 @@ #undef __GIMP_DRAWABLE_PDB_H__ #include "gimpdrawable_pdb.h" + +/** + * SECTION: gimpdrawable + * @title: gimpdrawable + * @short_description: Functions to manipulate drawables. + * + * Functions to manipulate drawables. + **/ + + /** * gimp_drawable_is_valid: * @drawable_ID: The drawable to check. diff --git a/libgimp/gimpdrawabletransform_pdb.c b/libgimp/gimpdrawabletransform_pdb.c index fcf520c837..466558023c 100644 --- a/libgimp/gimpdrawabletransform_pdb.c +++ b/libgimp/gimpdrawabletransform_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpdrawabletransform + * @title: gimpdrawabletransform + * @short_description: Functions to perform transformatrions on drawables. + * + * Functions to perform transformatrions on drawables. + **/ + + /** * gimp_drawable_transform_flip_simple: * @drawable_ID: The affected drawable. diff --git a/libgimp/gimpedit_pdb.c b/libgimp/gimpedit_pdb.c index 0b0f32a71d..18791d5990 100644 --- a/libgimp/gimpedit_pdb.c +++ b/libgimp/gimpedit_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpedit + * @title: gimpedit + * @short_description: Edit menu functions (cut, copy, paste, clear, etc.) + * + * Edit menu functions (cut, copy, paste, clear, etc.) + **/ + + /** * gimp_edit_cut: * @drawable_ID: The drawable to cut from. diff --git a/libgimp/gimpfileops_pdb.c b/libgimp/gimpfileops_pdb.c index 12725b55e2..599242742f 100644 --- a/libgimp/gimpfileops_pdb.c +++ b/libgimp/gimpfileops_pdb.c @@ -26,6 +26,16 @@ #include "gimp.h" + +/** + * SECTION: gimpfileops + * @title: gimpfileops + * @short_description: File operations (load, save, etc.) + * + * File operations (load, save, etc.) + **/ + + /** * gimp_file_load: * @run_mode: The run mode. diff --git a/libgimp/gimpfloatingsel_pdb.c b/libgimp/gimpfloatingsel_pdb.c index 03e7d9db38..4b813d2606 100644 --- a/libgimp/gimpfloatingsel_pdb.c +++ b/libgimp/gimpfloatingsel_pdb.c @@ -27,6 +27,16 @@ #undef __GIMP_FLOATING_SEL_PDB_H__ #include "gimpfloatingsel_pdb.h" + +/** + * SECTION: gimpfloatingsel + * @title: gimpfloatingsel + * @short_description: Functions for removing or attaching floating selections. + * + * Functions for removing or attaching floating selections. + **/ + + /** * gimp_floating_sel_remove: * @floating_sel_ID: The floating selection. diff --git a/libgimp/gimpfonts_pdb.c b/libgimp/gimpfonts_pdb.c index 9bd0547dc8..ca3ee3a7b7 100644 --- a/libgimp/gimpfonts_pdb.c +++ b/libgimp/gimpfonts_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpfonts + * @title: gimpfonts + * @short_description: Operations related to fonts. + * + * Operations related to fonts. + **/ + + /** * gimp_fonts_refresh: * diff --git a/libgimp/gimpfontselect_pdb.c b/libgimp/gimpfontselect_pdb.c index 45f8656031..aea1556b1c 100644 --- a/libgimp/gimpfontselect_pdb.c +++ b/libgimp/gimpfontselect_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpfontselect + * @title: gimpfontselect + * @short_description: Functions providing a font selection dialog. + * + * Functions providing a font selection dialog. + **/ + + /** * gimp_fonts_popup: * @font_callback: The callback PDB proc to call when font selection is made. diff --git a/libgimp/gimpgimprc_pdb.c b/libgimp/gimpgimprc_pdb.c index 47b3959ad6..b67846d8a8 100644 --- a/libgimp/gimpgimprc_pdb.c +++ b/libgimp/gimpgimprc_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpgimprc + * @title: gimpgimprc + * @short_description: Interactions with settings from gimprc. + * + * Interactions with settings from gimprc. + **/ + + /** * gimp_gimprc_query: * @token: The token to query for. diff --git a/libgimp/gimpgradient_pdb.c b/libgimp/gimpgradient_pdb.c index c97c551530..bb862796a0 100644 --- a/libgimp/gimpgradient_pdb.c +++ b/libgimp/gimpgradient_pdb.c @@ -26,6 +26,16 @@ #include "gimp.h" + +/** + * SECTION: gimpgradient + * @title: gimpgradient + * @short_description: Functions operating on a single gradient. + * + * Functions operating on a single gradient. + **/ + + /** * gimp_gradient_new: * @name: The requested name of the new gradient. diff --git a/libgimp/gimpgradients_pdb.c b/libgimp/gimpgradients_pdb.c index fdb538e98a..6ea97c7864 100644 --- a/libgimp/gimpgradients_pdb.c +++ b/libgimp/gimpgradients_pdb.c @@ -29,6 +29,16 @@ #undef __GIMP_GRADIENTS_PDB_H__ #include "gimpgradients_pdb.h" + +/** + * SECTION: gimpgradients + * @title: gimpgradients + * @short_description: Operations related to gradients. + * + * Operations related to gradients. + **/ + + /** * gimp_gradients_refresh: * diff --git a/libgimp/gimpgradientselect_pdb.c b/libgimp/gimpgradientselect_pdb.c index 4ebfbc1e14..624d3c828c 100644 --- a/libgimp/gimpgradientselect_pdb.c +++ b/libgimp/gimpgradientselect_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpgradientselect + * @title: gimpgradientselect + * @short_description: Functions providing a gradient selection dialog. + * + * Functions providing a gradient selection dialog. + **/ + + /** * gimp_gradients_popup: * @gradient_callback: The callback PDB proc to call when gradient selection is made. diff --git a/libgimp/gimpgrid_pdb.c b/libgimp/gimpgrid_pdb.c index 9e7d645b3a..a716381cb7 100644 --- a/libgimp/gimpgrid_pdb.c +++ b/libgimp/gimpgrid_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpgrid + * @title: gimpgrid + * @short_description: Functions manuipulating an image's grid. + * + * Functions manuipulating an image's grid. + **/ + + /** * gimp_image_grid_get_spacing: * @image_ID: The image. diff --git a/libgimp/gimpguides_pdb.c b/libgimp/gimpguides_pdb.c index 29ec5faf4d..398e4863af 100644 --- a/libgimp/gimpguides_pdb.c +++ b/libgimp/gimpguides_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpguides + * @title: gimpguides + * @short_description: Functions for manipulating guides. + * + * Functions for manipulating guides. + **/ + + /** * gimp_image_add_hguide: * @image_ID: The image. diff --git a/libgimp/gimphelp_pdb.c b/libgimp/gimphelp_pdb.c index 8b3631e6b7..1c1def865c 100644 --- a/libgimp/gimphelp_pdb.c +++ b/libgimp/gimphelp_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimphelp + * @title: gimphelp + * @short_description: Loading help pages using gimp_help. + * + * Loading help pages using gimp_help. + **/ + + /** * gimp_help: * @help_domain: The help domain in which help_id is registered. diff --git a/libgimp/gimpimage_pdb.c b/libgimp/gimpimage_pdb.c index faa13c06e3..88d436e55a 100644 --- a/libgimp/gimpimage_pdb.c +++ b/libgimp/gimpimage_pdb.c @@ -29,6 +29,17 @@ #undef __GIMP_IMAGE_PDB_H__ #include "gimpimage_pdb.h" + +/** + * SECTION: gimpimage + * @title: gimpimage + * @short_description: Operations on complete images. + * + * Operations on complete images: creation, resizing/rescaling, and + * operations involving multiple layers. + **/ + + /** * gimp_image_is_valid: * @image_ID: The image to check. diff --git a/libgimp/gimplayer_pdb.c b/libgimp/gimplayer_pdb.c index bc336e8458..2ae3d1b5dc 100644 --- a/libgimp/gimplayer_pdb.c +++ b/libgimp/gimplayer_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimplayer + * @title: gimplayer + * @short_description: Operations on a single layer. + * + * Operations on a single layer. + **/ + + /** * _gimp_layer_new: * @image_ID: The image to which to add the layer. diff --git a/libgimp/gimpmessage_pdb.c b/libgimp/gimpmessage_pdb.c index bdcd6650c9..0faf57b48e 100644 --- a/libgimp/gimpmessage_pdb.c +++ b/libgimp/gimpmessage_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpmessage + * @title: gimpmessage + * @short_description: Display a dialog box with a message. + * + * Display a dialog box with a message. + **/ + + /** * gimp_message: * @message: Message to display in the dialog. diff --git a/libgimp/gimpmisc_pdb.c b/libgimp/gimpmisc_pdb.c index 1b4f5915bd..836889a5fe 100644 --- a/libgimp/gimpmisc_pdb.c +++ b/libgimp/gimpmisc_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpmisc + * @title: gimpmisc + * @short_description: Miscellaneous procedures + * + * Miscellaneous procedures not fitting in any category. + **/ + + /** * gimp_version: * diff --git a/libgimp/gimppainttools_pdb.c b/libgimp/gimppainttools_pdb.c index a12fe2c4cf..1548ced499 100644 --- a/libgimp/gimppainttools_pdb.c +++ b/libgimp/gimppainttools_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimppainttools + * @title: gimppainttools + * @short_description: Access to toolbox paint tools. + * + * Functions giving access to toolbox paint tools. + **/ + + /** * gimp_airbrush: * @drawable_ID: The affected drawable. diff --git a/libgimp/gimppalette_pdb.c b/libgimp/gimppalette_pdb.c index d9bf68150e..ad515ecebc 100644 --- a/libgimp/gimppalette_pdb.c +++ b/libgimp/gimppalette_pdb.c @@ -26,6 +26,16 @@ #include "gimp.h" + +/** + * SECTION: gimppalette + * @title: gimppalette + * @short_description: Functions operating on a single palette. + * + * Functions operating on a single palette. + **/ + + /** * gimp_palette_new: * @name: The requested name of the new palette. diff --git a/libgimp/gimppalettes_pdb.c b/libgimp/gimppalettes_pdb.c index 7a26b3d585..6fb1b82fb7 100644 --- a/libgimp/gimppalettes_pdb.c +++ b/libgimp/gimppalettes_pdb.c @@ -27,6 +27,16 @@ #undef __GIMP_PALETTES_PDB_H__ #include "gimppalettes_pdb.h" + +/** + * SECTION: gimppalettes + * @title: gimppalettes + * @short_description: Operations related to palettes. + * + * Operations related to palettes. + **/ + + /** * gimp_palettes_refresh: * diff --git a/libgimp/gimppaletteselect_pdb.c b/libgimp/gimppaletteselect_pdb.c index 4a720b4939..c8fb9083af 100644 --- a/libgimp/gimppaletteselect_pdb.c +++ b/libgimp/gimppaletteselect_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimppaletteselect + * @title: gimppaletteselect + * @short_description: Functions providing a palette selection dialog. + * + * Functions providing a palette selection dialog. + **/ + + /** * gimp_palettes_popup: * @palette_callback: The callback PDB proc to call when palette selection is made. diff --git a/libgimp/gimpparasite_pdb.c b/libgimp/gimpparasite_pdb.c index ff76426992..1355c739d4 100644 --- a/libgimp/gimpparasite_pdb.c +++ b/libgimp/gimpparasite_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpparasite + * @title: gimpparasite + * @short_description: Operations related to parasites. + * + * Operations related to parasites. + **/ + + /** * gimp_parasite_find: * @name: The name of the parasite to find. diff --git a/libgimp/gimppaths_pdb.c b/libgimp/gimppaths_pdb.c index 03e98a0bdd..5ff0c0ca17 100644 --- a/libgimp/gimppaths_pdb.c +++ b/libgimp/gimppaths_pdb.c @@ -29,6 +29,16 @@ #undef __GIMP_PATHS_PDB_H__ #include "gimppaths_pdb.h" + +/** + * SECTION: gimppaths + * @title: gimppaths + * @short_description: Deprecated operations related to paths. + * + * Deprecated operations related to paths. + **/ + + /** * gimp_path_list: * @image_ID: The image to list the paths from. diff --git a/libgimp/gimppattern_pdb.c b/libgimp/gimppattern_pdb.c index 21c310e85e..52ec1bc2d4 100644 --- a/libgimp/gimppattern_pdb.c +++ b/libgimp/gimppattern_pdb.c @@ -26,6 +26,16 @@ #include "gimp.h" + +/** + * SECTION: gimppattern + * @title: gimppattern + * @short_description: Functions operating on a single pattern. + * + * Functions operating on a single pattern. + **/ + + /** * gimp_pattern_get_info: * @name: The pattern name. diff --git a/libgimp/gimppatterns_pdb.c b/libgimp/gimppatterns_pdb.c index c106f39474..0e460b647a 100644 --- a/libgimp/gimppatterns_pdb.c +++ b/libgimp/gimppatterns_pdb.c @@ -29,6 +29,16 @@ #undef __GIMP_PATTERNS_PDB_H__ #include "gimppatterns_pdb.h" + +/** + * SECTION: gimppatterns + * @title: gimppatterns + * @short_description: Functions relating to patterns. + * + * Functions relating to patterns. + **/ + + /** * gimp_patterns_refresh: * diff --git a/libgimp/gimppatternselect_pdb.c b/libgimp/gimppatternselect_pdb.c index 9f2fc05c21..881cc8b724 100644 --- a/libgimp/gimppatternselect_pdb.c +++ b/libgimp/gimppatternselect_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimppatternselect + * @title: gimppatternselect + * @short_description: Functions providing a pattern selection dialog. + * + * Functions providing a pattern selection dialog. + **/ + + /** * gimp_patterns_popup: * @pattern_callback: The callback PDB proc to call when pattern selection is made. diff --git a/libgimp/gimpplugin_pdb.c b/libgimp/gimpplugin_pdb.c index 0b87dccedb..85125a6f7e 100644 --- a/libgimp/gimpplugin_pdb.c +++ b/libgimp/gimpplugin_pdb.c @@ -24,6 +24,17 @@ #include "gimp.h" + +/** + * SECTION: gimpplugin + * @title: gimpplugin + * @short_description: Functions useful for plugins, e.g. registration and progress indicators. + * + * Functions useful for plugins, e.g. registration and progress + * indicators. + **/ + + /** * gimp_plugin_domain_register: * @domain_name: The name of the textdomain (must be unique). diff --git a/libgimp/gimpproceduraldb_pdb.c b/libgimp/gimpproceduraldb_pdb.c index 154126bf91..c172fb3f3a 100644 --- a/libgimp/gimpproceduraldb_pdb.c +++ b/libgimp/gimpproceduraldb_pdb.c @@ -26,6 +26,17 @@ #include "gimp.h" + +/** + * SECTION: gimpproceduraldb + * @title: gimpproceduraldb + * @short_description: Functions for querying and changing procedural database (PDB) entries. + * + * Functions for querying and changing procedural database (PDB) + * entries. + **/ + + /** * gimp_procedural_db_temp_name: * diff --git a/libgimp/gimpprogress_pdb.c b/libgimp/gimpprogress_pdb.c index b61aca56f0..a62d6dd9ce 100644 --- a/libgimp/gimpprogress_pdb.c +++ b/libgimp/gimpprogress_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpprogress + * @title: gimpprogress + * @short_description: Functions for embedding the progress bar into a plug-in's GUI. + * + * Functions for embedding the progress bar into a plug-in's GUI. + **/ + + /** * _gimp_progress_init: * @message: Message to use in the progress dialog. diff --git a/libgimp/gimpselection_pdb.c b/libgimp/gimpselection_pdb.c index 2737a04fa2..554747f631 100644 --- a/libgimp/gimpselection_pdb.c +++ b/libgimp/gimpselection_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpselection + * @title: gimpselection + * @short_description: Functions for manipulating selections. + * + * Functions for manipulating selections. + **/ + + /** * gimp_selection_bounds: * @image_ID: The image. diff --git a/libgimp/gimpselectiontools_pdb.c b/libgimp/gimpselectiontools_pdb.c index b9a3648879..b7c007d200 100644 --- a/libgimp/gimpselectiontools_pdb.c +++ b/libgimp/gimpselectiontools_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpselectiontools + * @title: gimpselectiontools + * @short_description: Access to toolbox selection tools. + * + * Functions giving access to toolbox selection tools. + **/ + + /** * gimp_by_color_select: * @drawable_ID: The affected drawable. diff --git a/libgimp/gimptextlayer_pdb.c b/libgimp/gimptextlayer_pdb.c index 68297a7fe7..e5a4dad34c 100644 --- a/libgimp/gimptextlayer_pdb.c +++ b/libgimp/gimptextlayer_pdb.c @@ -27,6 +27,16 @@ #undef __GIMP_TEXT_LAYER_PDB_H__ #include "gimptextlayer_pdb.h" + +/** + * SECTION: gimptextlayer + * @title: gimptextlayer + * @short_description: Functions for querying and manipulating text layers. + * + * Functions for querying and manipulating text layers. + **/ + + /** * gimp_text_layer_new: * @image_ID: The image. diff --git a/libgimp/gimptexttool_pdb.c b/libgimp/gimptexttool_pdb.c index 65455f3def..fe603ddff8 100644 --- a/libgimp/gimptexttool_pdb.c +++ b/libgimp/gimptexttool_pdb.c @@ -27,6 +27,16 @@ #undef __GIMP_TEXT_TOOL_PDB_H__ #include "gimptexttool_pdb.h" + +/** + * SECTION: gimptexttool + * @title: gimptexttool + * @short_description: Functions for controlling the text tool. + * + * Functions for controlling the text tool. + **/ + + /** * gimp_text_fontname: * @image_ID: The image. diff --git a/libgimp/gimptransformtools_pdb.c b/libgimp/gimptransformtools_pdb.c index 667c9df5b4..1011a9acaa 100644 --- a/libgimp/gimptransformtools_pdb.c +++ b/libgimp/gimptransformtools_pdb.c @@ -27,6 +27,16 @@ #undef __GIMP_TRANSFORM_TOOLS_PDB_H__ #include "gimptransformtools_pdb.h" + +/** + * SECTION: gimptransformtools + * @title: gimptransformtools + * @short_description: Access to toolbox transform tools. + * + * Functions giving access to toolbox transform tools. + **/ + + /** * gimp_flip: * @drawable_ID: The affected drawable. diff --git a/libgimp/gimpundo_pdb.c b/libgimp/gimpundo_pdb.c index a680903eb3..3e426b29a9 100644 --- a/libgimp/gimpundo_pdb.c +++ b/libgimp/gimpundo_pdb.c @@ -24,6 +24,16 @@ #include "gimp.h" + +/** + * SECTION: gimpundo + * @title: gimpundo + * @short_description: Control of undo/redo. + * + * Control of undo/redo. + **/ + + /** * gimp_image_undo_group_start: * @image_ID: The ID of the image in which to open an undo group. diff --git a/libgimp/gimpunit_pdb.c b/libgimp/gimpunit_pdb.c index 1d6170796c..8e725b6332 100644 --- a/libgimp/gimpunit_pdb.c +++ b/libgimp/gimpunit_pdb.c @@ -24,6 +24,17 @@ #include "gimp.h" + +/** + * SECTION: gimpunit + * @title: gimpunit + * @short_description: Provides a collection of predefined units and functions for creating user-defined units. + * + * Provides a collection of predefined units and functions for creating + * user-defined units. + **/ + + /** * _gimp_unit_get_number_of_units: * diff --git a/libgimp/gimpvectors_pdb.c b/libgimp/gimpvectors_pdb.c index 740a902b52..26d323ba28 100644 --- a/libgimp/gimpvectors_pdb.c +++ b/libgimp/gimpvectors_pdb.c @@ -26,6 +26,16 @@ #include "gimp.h" + +/** + * SECTION: gimpvectors + * @title: gimpvectors + * @short_description: Functions for querying and manipulating vectors. + * + * Functions for querying and manipulating vectors. + **/ + + /** * gimp_vectors_is_valid: * @vectors_ID: The vectors object to check. @@ -1546,7 +1556,7 @@ gimp_vectors_export_to_file (gint32 image_ID, * Save a path as an SVG string. * * This procedure works like gimp_vectors_export_to_file() but creates - * a string rather than a file. The contents are a %NUL-terminated + * a string rather than a file. The contents are a NUL-terminated * string that holds a complete XML document. If you pass 0 as the * 'vectors' argument, then all paths in the image will be exported. * diff --git a/tools/pdbgen/lib.pl b/tools/pdbgen/lib.pl index 4cb06d8e85..63b94d7229 100644 --- a/tools/pdbgen/lib.pl +++ b/tools/pdbgen/lib.pl @@ -655,6 +655,19 @@ HEADER print CFILE "#undef __GIMP_\U$group\E_PDB_H__\n"; print CFILE qq/#include "${hname}"\n/; } + $long_desc = &desc_wrap($main::grp{$group}->{doc_long_desc}); + print CFILE <{doc_title} + * \@title: $main::grp{$group}->{doc_title} + * \@short_description: $main::grp{$group}->{doc_short_desc} + * +${long_desc} + **/ + +SECTION_DOCS print CFILE "\n", $extra->{code} if exists $extra->{code}; print CFILE $out->{code}; close CFILE; diff --git a/tools/pdbgen/pdb/brush.pdb b/tools/pdbgen/pdb/brush.pdb index 2abf765d2c..561d827eda 100644 --- a/tools/pdbgen/pdb/brush.pdb +++ b/tools/pdbgen/pdb/brush.pdb @@ -864,5 +864,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Brush'; +$doc_title = 'gimpbrush'; +$doc_short_desc = 'Functions operating on a single brush.'; +$doc_long_desc = 'Functions operating on a single brush.'; 1; diff --git a/tools/pdbgen/pdb/brush_select.pdb b/tools/pdbgen/pdb/brush_select.pdb index bb865358c1..0df1c3cef1 100644 --- a/tools/pdbgen/pdb/brush_select.pdb +++ b/tools/pdbgen/pdb/brush_select.pdb @@ -129,5 +129,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Brush UI'; +$doc_title = 'gimpbrushselect'; +$doc_short_desc = 'Functions providing a brush selection dialog.'; +$doc_long_desc = 'Functions providing a brush selection dialog.'; 1; diff --git a/tools/pdbgen/pdb/brushes.pdb b/tools/pdbgen/pdb/brushes.pdb index da9e07c01d..fc6688115e 100644 --- a/tools/pdbgen/pdb/brushes.pdb +++ b/tools/pdbgen/pdb/brushes.pdb @@ -214,5 +214,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Brushes'; +$doc_title = 'gimpbrushes'; +$doc_short_desc = 'Functions for manipulating brushes.'; +$doc_long_desc = 'Functions related to getting and setting brushes.'; 1; diff --git a/tools/pdbgen/pdb/buffer.pdb b/tools/pdbgen/pdb/buffer.pdb index 08753abc14..ffb3aa475e 100644 --- a/tools/pdbgen/pdb/buffer.pdb +++ b/tools/pdbgen/pdb/buffer.pdb @@ -248,5 +248,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Buffer procedures'; +$doc_title = 'gimpbuffer'; +$doc_short_desc = 'Functions for manipulating cut buffers.'; +$doc_long_desc = 'Functions related to named cut buffers.'; 1; diff --git a/tools/pdbgen/pdb/channel.pdb b/tools/pdbgen/pdb/channel.pdb index 455910d0dc..9d26dfa7f8 100644 --- a/tools/pdbgen/pdb/channel.pdb +++ b/tools/pdbgen/pdb/channel.pdb @@ -354,5 +354,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Channel'; +$doc_title = 'gimpchannel'; +$doc_short_desc = 'Functions for manipulating channels.'; +$doc_long_desc = 'Functions for manipulating channels.'; 1; diff --git a/tools/pdbgen/pdb/color.pdb b/tools/pdbgen/pdb/color.pdb index bea3fdd734..aa06683000 100644 --- a/tools/pdbgen/pdb/color.pdb +++ b/tools/pdbgen/pdb/color.pdb @@ -718,5 +718,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Color'; +$doc_title = 'gimpcolor'; +$doc_short_desc = 'Functions for manipulating color.'; +$doc_long_desc = 'Functions for manipulating color, including curves and histograms.'; 1; diff --git a/tools/pdbgen/pdb/context.pdb b/tools/pdbgen/pdb/context.pdb index f670dd6982..6005378502 100644 --- a/tools/pdbgen/pdb/context.pdb +++ b/tools/pdbgen/pdb/context.pdb @@ -733,5 +733,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Context'; +$doc_title = 'gimpcontext'; +$doc_short_desc = "Functions to manipulate a plug-in's context."; +$doc_long_desc = "Functions to manipulate a plug-in's context."; 1; diff --git a/tools/pdbgen/pdb/convert.pdb b/tools/pdbgen/pdb/convert.pdb index 35100b2533..386d60a494 100644 --- a/tools/pdbgen/pdb/convert.pdb +++ b/tools/pdbgen/pdb/convert.pdb @@ -223,5 +223,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Convert'; +$doc_title = 'gimpconvert'; +$doc_short_desc = 'Conversions between RGB, indexed, and grayscale modes.'; +$doc_long_desc = 'Conversions between RGB, indexed, and grayscale modes.'; 1; diff --git a/tools/pdbgen/pdb/display.pdb b/tools/pdbgen/pdb/display.pdb index edebd63c37..168cdfd8d3 100644 --- a/tools/pdbgen/pdb/display.pdb +++ b/tools/pdbgen/pdb/display.pdb @@ -221,5 +221,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Display procedures'; +$doc_title = 'gimpdisplay'; +$doc_short_desc = 'Functions to create, delete and flush displays (views) on an image.'; +$doc_long_desc = 'Functions to create, delete and flush displays (views) on an image.'; 1; diff --git a/tools/pdbgen/pdb/drawable.pdb b/tools/pdbgen/pdb/drawable.pdb index 94566cae54..3432cbafd9 100644 --- a/tools/pdbgen/pdb/drawable.pdb +++ b/tools/pdbgen/pdb/drawable.pdb @@ -1434,5 +1434,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Drawable procedures'; +$doc_title = 'gimpdrawable'; +$doc_short_desc = 'Functions to manipulate drawables.'; +$doc_long_desc = 'Functions to manipulate drawables.'; 1; diff --git a/tools/pdbgen/pdb/drawable_transform.pdb b/tools/pdbgen/pdb/drawable_transform.pdb index 90ae02a1b8..655d60db2d 100644 --- a/tools/pdbgen/pdb/drawable_transform.pdb +++ b/tools/pdbgen/pdb/drawable_transform.pdb @@ -1055,5 +1055,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Transformation procedures'; +$doc_title = 'gimpdrawabletransform'; +$doc_short_desc = 'Functions to perform transformatrions on drawables.'; +$doc_long_desc = 'Functions to perform transformatrions on drawables.'; 1; diff --git a/tools/pdbgen/pdb/edit.pdb b/tools/pdbgen/pdb/edit.pdb index fa972469f3..421f74c6c7 100644 --- a/tools/pdbgen/pdb/edit.pdb +++ b/tools/pdbgen/pdb/edit.pdb @@ -939,5 +939,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Edit procedures'; +$doc_title = 'gimpedit'; +$doc_short_desc = 'Edit menu functions (cut, copy, paste, clear, etc.)'; +$doc_long_desc = 'Edit menu functions (cut, copy, paste, clear, etc.)'; 1; diff --git a/tools/pdbgen/pdb/fileops.pdb b/tools/pdbgen/pdb/fileops.pdb index fac09632d8..93c21e3678 100644 --- a/tools/pdbgen/pdb/fileops.pdb +++ b/tools/pdbgen/pdb/fileops.pdb @@ -637,5 +637,8 @@ CODE %exports = (app => [@procs], lib => [@procs[0..3,5..11]]); $desc = 'File Operations'; +$doc_title = 'gimpfileops'; +$doc_short_desc = 'File operations (load, save, etc.)'; +$doc_long_desc = 'File operations (load, save, etc.)'; 1; diff --git a/tools/pdbgen/pdb/floating_sel.pdb b/tools/pdbgen/pdb/floating_sel.pdb index 8be541fc63..f2030d2fdd 100644 --- a/tools/pdbgen/pdb/floating_sel.pdb +++ b/tools/pdbgen/pdb/floating_sel.pdb @@ -211,5 +211,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Floating selections'; +$doc_title = 'gimpfloatingsel'; +$doc_short_desc = 'Functions for removing or attaching floating selections.'; +$doc_long_desc = 'Functions for removing or attaching floating selections.'; 1; diff --git a/tools/pdbgen/pdb/font_select.pdb b/tools/pdbgen/pdb/font_select.pdb index 756c8765fd..5ec44fa32a 100644 --- a/tools/pdbgen/pdb/font_select.pdb +++ b/tools/pdbgen/pdb/font_select.pdb @@ -104,5 +104,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Font UI'; +$doc_title = 'gimpfontselect'; +$doc_short_desc = 'Functions providing a font selection dialog.'; +$doc_long_desc = 'Functions providing a font selection dialog.'; 1; diff --git a/tools/pdbgen/pdb/fonts.pdb b/tools/pdbgen/pdb/fonts.pdb index 2adaf9e6e1..e4e77727a3 100644 --- a/tools/pdbgen/pdb/fonts.pdb +++ b/tools/pdbgen/pdb/fonts.pdb @@ -78,5 +78,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Fonts'; +$doc_title = 'gimpfonts'; +$doc_short_desc = 'Operations related to fonts.'; +$doc_long_desc = 'Operations related to fonts.'; 1; diff --git a/tools/pdbgen/pdb/gimprc.pdb b/tools/pdbgen/pdb/gimprc.pdb index 86239f324a..b8863f6d3f 100644 --- a/tools/pdbgen/pdb/gimprc.pdb +++ b/tools/pdbgen/pdb/gimprc.pdb @@ -250,5 +250,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Gimprc procedures'; +$doc_title = 'gimpgimprc'; +$doc_short_desc = 'Interactions with settings from gimprc.'; +$doc_long_desc = 'Interactions with settings from gimprc.'; 1; diff --git a/tools/pdbgen/pdb/gradient.pdb b/tools/pdbgen/pdb/gradient.pdb index 17d36cd566..25e0c8c6d5 100644 --- a/tools/pdbgen/pdb/gradient.pdb +++ b/tools/pdbgen/pdb/gradient.pdb @@ -1459,5 +1459,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Gradient'; +$doc_title = 'gimpgradient'; +$doc_short_desc = 'Functions operating on a single gradient.'; +$doc_long_desc = 'Functions operating on a single gradient.'; 1; diff --git a/tools/pdbgen/pdb/gradient_select.pdb b/tools/pdbgen/pdb/gradient_select.pdb index a7618c71e1..b7ffb8d842 100644 --- a/tools/pdbgen/pdb/gradient_select.pdb +++ b/tools/pdbgen/pdb/gradient_select.pdb @@ -116,5 +116,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Gradient UI'; +$doc_title = 'gimpgradientselect'; +$doc_short_desc = 'Functions providing a gradient selection dialog.'; +$doc_long_desc = 'Functions providing a gradient selection dialog.'; 1; diff --git a/tools/pdbgen/pdb/gradients.pdb b/tools/pdbgen/pdb/gradients.pdb index 89965762fd..d7a4ae4fcf 100644 --- a/tools/pdbgen/pdb/gradients.pdb +++ b/tools/pdbgen/pdb/gradients.pdb @@ -261,5 +261,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Gradients'; +$doc_title = 'gimpgradients'; +$doc_short_desc = 'Operations related to gradients.'; +$doc_long_desc = 'Operations related to gradients.'; 1; diff --git a/tools/pdbgen/pdb/grid.pdb b/tools/pdbgen/pdb/grid.pdb index a4616970da..82c07b536c 100644 --- a/tools/pdbgen/pdb/grid.pdb +++ b/tools/pdbgen/pdb/grid.pdb @@ -365,5 +365,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Image grid procedures'; +$doc_title = 'gimpgrid'; +$doc_short_desc = "Functions manuipulating an image's grid."; +$doc_long_desc = "Functions manuipulating an image's grid."; 1; diff --git a/tools/pdbgen/pdb/guides.pdb b/tools/pdbgen/pdb/guides.pdb index 5d87f27b86..42a84eae50 100644 --- a/tools/pdbgen/pdb/guides.pdb +++ b/tools/pdbgen/pdb/guides.pdb @@ -247,5 +247,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Guide procedures'; +$doc_title = 'gimpguides'; +$doc_short_desc = 'Functions for manipulating guides.'; +$doc_long_desc = 'Functions for manipulating guides.'; 1; diff --git a/tools/pdbgen/pdb/help.pdb b/tools/pdbgen/pdb/help.pdb index 04971b8766..4512a4ad40 100644 --- a/tools/pdbgen/pdb/help.pdb +++ b/tools/pdbgen/pdb/help.pdb @@ -65,5 +65,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Help procedures'; +$doc_title = 'gimphelp'; +$doc_short_desc = 'Loading help pages using gimp_help.'; +$doc_long_desc = 'Loading help pages using gimp_help.'; 1; diff --git a/tools/pdbgen/pdb/image.pdb b/tools/pdbgen/pdb/image.pdb index dc968c4e55..98fcb56c5b 100644 --- a/tools/pdbgen/pdb/image.pdb +++ b/tools/pdbgen/pdb/image.pdb @@ -2729,5 +2729,8 @@ CODE %exports = (app => [@procs], lib => [@procs[0..46,49..77]]); $desc = 'Image'; +$doc_title = 'gimpimage'; +$doc_short_desc = 'Operations on complete images.'; +$doc_long_desc = 'Operations on complete images: creation, resizing/rescaling, and operations involving multiple layers.'; 1; diff --git a/tools/pdbgen/pdb/layer.pdb b/tools/pdbgen/pdb/layer.pdb index d8f7c99736..4de7817d05 100644 --- a/tools/pdbgen/pdb/layer.pdb +++ b/tools/pdbgen/pdb/layer.pdb @@ -1105,5 +1105,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Layer'; +$doc_title = 'gimplayer'; +$doc_short_desc = 'Operations on a single layer.'; +$doc_long_desc = 'Operations on a single layer.'; 1; diff --git a/tools/pdbgen/pdb/message.pdb b/tools/pdbgen/pdb/message.pdb index 144d426e48..7ccbc3476e 100644 --- a/tools/pdbgen/pdb/message.pdb +++ b/tools/pdbgen/pdb/message.pdb @@ -109,5 +109,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Message procedures'; +$doc_title = 'gimpmessage'; +$doc_short_desc = 'Display a dialog box with a message.'; +$doc_long_desc = 'Display a dialog box with a message.'; 1; diff --git a/tools/pdbgen/pdb/misc.pdb b/tools/pdbgen/pdb/misc.pdb index bfaafad30a..f73788e541 100644 --- a/tools/pdbgen/pdb/misc.pdb +++ b/tools/pdbgen/pdb/misc.pdb @@ -99,5 +99,8 @@ CODE %exports = (app => [@procs], lib => [@procs[0..1]]); $desc = 'Miscellaneous'; +$doc_title = 'gimpmisc'; +$doc_short_desc = 'Miscellaneous procedures'; +$doc_long_desc = 'Miscellaneous procedures not fitting in any category.'; 1; diff --git a/tools/pdbgen/pdb/paint_tools.pdb b/tools/pdbgen/pdb/paint_tools.pdb index 1d916b33d2..e5300eed97 100644 --- a/tools/pdbgen/pdb/paint_tools.pdb +++ b/tools/pdbgen/pdb/paint_tools.pdb @@ -996,5 +996,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Paint Tool procedures'; +$doc_title = 'gimppainttools'; +$doc_short_desc = 'Access to toolbox paint tools.'; +$doc_long_desc = 'Functions giving access to toolbox paint tools.'; 1; diff --git a/tools/pdbgen/pdb/palette.pdb b/tools/pdbgen/pdb/palette.pdb index 15f27a703b..cff5dacfb9 100644 --- a/tools/pdbgen/pdb/palette.pdb +++ b/tools/pdbgen/pdb/palette.pdb @@ -607,5 +607,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Palette'; +$doc_title = 'gimppalette'; +$doc_short_desc = 'Functions operating on a single palette.'; +$doc_long_desc = 'Functions operating on a single palette.'; 1; diff --git a/tools/pdbgen/pdb/palette_select.pdb b/tools/pdbgen/pdb/palette_select.pdb index f9fd44b2cd..5022e2588a 100644 --- a/tools/pdbgen/pdb/palette_select.pdb +++ b/tools/pdbgen/pdb/palette_select.pdb @@ -109,5 +109,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Palette UI'; +$doc_title = 'gimppaletteselect'; +$doc_short_desc = 'Functions providing a palette selection dialog.'; +$doc_long_desc = 'Functions providing a palette selection dialog.'; 1; diff --git a/tools/pdbgen/pdb/palettes.pdb b/tools/pdbgen/pdb/palettes.pdb index 4a9288ffcd..164740d54d 100644 --- a/tools/pdbgen/pdb/palettes.pdb +++ b/tools/pdbgen/pdb/palettes.pdb @@ -160,5 +160,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Palettes'; +$doc_title = 'gimppalettes'; +$doc_short_desc = 'Operations related to palettes.'; +$doc_long_desc = 'Operations related to palettes.'; 1; diff --git a/tools/pdbgen/pdb/parasite.pdb b/tools/pdbgen/pdb/parasite.pdb index f807f13a74..804077d407 100644 --- a/tools/pdbgen/pdb/parasite.pdb +++ b/tools/pdbgen/pdb/parasite.pdb @@ -464,5 +464,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Parasite procedures'; +$doc_title = 'gimpparasite'; +$doc_short_desc = 'Operations related to parasites.'; +$doc_long_desc = 'Operations related to parasites.'; 1; diff --git a/tools/pdbgen/pdb/paths.pdb b/tools/pdbgen/pdb/paths.pdb index bf6d11ed12..2f6c68fa45 100644 --- a/tools/pdbgen/pdb/paths.pdb +++ b/tools/pdbgen/pdb/paths.pdb @@ -619,5 +619,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Paths'; +$doc_title = 'gimppaths'; +$doc_short_desc = 'Deprecated operations related to paths.'; +$doc_long_desc = 'Deprecated operations related to paths.'; 1; diff --git a/tools/pdbgen/pdb/pattern.pdb b/tools/pdbgen/pdb/pattern.pdb index 898e22b061..a3b55fd995 100644 --- a/tools/pdbgen/pdb/pattern.pdb +++ b/tools/pdbgen/pdb/pattern.pdb @@ -124,5 +124,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Pattern'; +$doc_title = 'gimppattern'; +$doc_short_desc = 'Functions operating on a single pattern.'; +$doc_long_desc = 'Functions operating on a single pattern.'; 1; diff --git a/tools/pdbgen/pdb/pattern_select.pdb b/tools/pdbgen/pdb/pattern_select.pdb index 352e52401e..deaf72de4a 100644 --- a/tools/pdbgen/pdb/pattern_select.pdb +++ b/tools/pdbgen/pdb/pattern_select.pdb @@ -109,5 +109,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Pattern UI'; +$doc_title = 'gimppatternselect'; +$doc_short_desc = 'Functions providing a pattern selection dialog.'; +$doc_long_desc = 'Functions providing a pattern selection dialog.'; 1; diff --git a/tools/pdbgen/pdb/patterns.pdb b/tools/pdbgen/pdb/patterns.pdb index 713fa655ed..e341a1f266 100644 --- a/tools/pdbgen/pdb/patterns.pdb +++ b/tools/pdbgen/pdb/patterns.pdb @@ -165,5 +165,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Patterns'; +$doc_title = 'gimppatterns'; +$doc_short_desc = 'Functions relating to patterns.'; +$doc_long_desc = 'Functions relating to patterns.'; 1; diff --git a/tools/pdbgen/pdb/plug_in.pdb b/tools/pdbgen/pdb/plug_in.pdb index 2615329274..a172de7e0d 100644 --- a/tools/pdbgen/pdb/plug_in.pdb +++ b/tools/pdbgen/pdb/plug_in.pdb @@ -376,5 +376,8 @@ CODE %exports = (app => [@procs], lib => [@procs[1,2,3,4,5,6,7]]); $desc = 'Plug-in'; +$doc_title = 'gimpplugin'; +$doc_short_desc = 'Functions useful for plugins, e.g. registration and progress indicators.'; +$doc_long_desc = 'Functions useful for plugins, e.g. registration and progress indicators.'; 1; diff --git a/tools/pdbgen/pdb/procedural_db.pdb b/tools/pdbgen/pdb/procedural_db.pdb index 4ae6a6af7f..308b1da075 100644 --- a/tools/pdbgen/pdb/procedural_db.pdb +++ b/tools/pdbgen/pdb/procedural_db.pdb @@ -510,5 +510,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Procedural database'; +$doc_title = 'gimpproceduraldb'; +$doc_short_desc = 'Functions for querying and changing procedural database (PDB) entries.'; +$doc_long_desc = 'Functions for querying and changing procedural database (PDB) entries.'; 1; diff --git a/tools/pdbgen/pdb/progress.pdb b/tools/pdbgen/pdb/progress.pdb index 8a1a2f6070..8cd57fcb25 100644 --- a/tools/pdbgen/pdb/progress.pdb +++ b/tools/pdbgen/pdb/progress.pdb @@ -314,5 +314,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Progress'; +$doc_title = 'gimpprogress'; +$doc_short_desc = "Functions for embedding the progress bar into a plug-in's GUI."; +$doc_long_desc = "Functions for embedding the progress bar into a plug-in's GUI."; 1; diff --git a/tools/pdbgen/pdb/selection.pdb b/tools/pdbgen/pdb/selection.pdb index 809579dde6..565943e030 100644 --- a/tools/pdbgen/pdb/selection.pdb +++ b/tools/pdbgen/pdb/selection.pdb @@ -564,5 +564,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Image mask'; +$doc_title = 'gimpselection'; +$doc_short_desc = 'Functions for manipulating selections.'; +$doc_long_desc = 'Functions for manipulating selections.'; 1; diff --git a/tools/pdbgen/pdb/selection_tools.pdb b/tools/pdbgen/pdb/selection_tools.pdb index b6c43addbb..8d7356c3da 100644 --- a/tools/pdbgen/pdb/selection_tools.pdb +++ b/tools/pdbgen/pdb/selection_tools.pdb @@ -540,5 +540,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Selection Tool procedures'; +$doc_title = 'gimpselectiontools'; +$doc_short_desc = 'Access to toolbox selection tools.'; +$doc_long_desc = 'Functions giving access to toolbox selection tools.'; 1; diff --git a/tools/pdbgen/pdb/text_layer.pdb b/tools/pdbgen/pdb/text_layer.pdb index fe3e8e42be..dad0ceaa76 100644 --- a/tools/pdbgen/pdb/text_layer.pdb +++ b/tools/pdbgen/pdb/text_layer.pdb @@ -1241,5 +1241,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Text layer procedures'; +$doc_title = 'gimptextlayer'; +$doc_short_desc = 'Functions for querying and manipulating text layers.'; +$doc_long_desc = 'Functions for querying and manipulating text layers.'; 1; diff --git a/tools/pdbgen/pdb/text_tool.pdb b/tools/pdbgen/pdb/text_tool.pdb index 08caf28293..9ce194d382 100644 --- a/tools/pdbgen/pdb/text_tool.pdb +++ b/tools/pdbgen/pdb/text_tool.pdb @@ -279,5 +279,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Text procedures'; +$doc_title = 'gimptexttool'; +$doc_short_desc = 'Functions for controlling the text tool.'; +$doc_long_desc = 'Functions for controlling the text tool.'; 1; diff --git a/tools/pdbgen/pdb/transform_tools.pdb b/tools/pdbgen/pdb/transform_tools.pdb index 12d32ee05a..c3f827d22c 100644 --- a/tools/pdbgen/pdb/transform_tools.pdb +++ b/tools/pdbgen/pdb/transform_tools.pdb @@ -430,5 +430,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Transform Tool procedures'; +$doc_title = 'gimptransformtools'; +$doc_short_desc = 'Access to toolbox transform tools.'; +$doc_long_desc = 'Functions giving access to toolbox transform tools.'; 1; diff --git a/tools/pdbgen/pdb/undo.pdb b/tools/pdbgen/pdb/undo.pdb index 9875bcd738..ca509abcf9 100644 --- a/tools/pdbgen/pdb/undo.pdb +++ b/tools/pdbgen/pdb/undo.pdb @@ -299,5 +299,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Undo'; +$doc_title = 'gimpundo'; +$doc_short_desc = 'Control of undo/redo.'; +$doc_long_desc = 'Control of undo/redo.'; 1; diff --git a/tools/pdbgen/pdb/unit.pdb b/tools/pdbgen/pdb/unit.pdb index 14d3ad27df..31bd434dab 100644 --- a/tools/pdbgen/pdb/unit.pdb +++ b/tools/pdbgen/pdb/unit.pdb @@ -368,5 +368,9 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Units'; +$doc_title = 'gimpunit'; +$doc_short_desc = 'Provides a collection of predefined units and functions for creating user-defined units.'; +$doc_long_desc = 'Provides a collection of predefined units and functions for creating user-defined units.'; +$doc_see_also = '#GimpUnitMenu, #GimpSizeEntry'; 1; diff --git a/tools/pdbgen/pdb/vectors.pdb b/tools/pdbgen/pdb/vectors.pdb index b02897254d..86e0f8aa2e 100644 --- a/tools/pdbgen/pdb/vectors.pdb +++ b/tools/pdbgen/pdb/vectors.pdb @@ -1540,7 +1540,7 @@ sub vectors_export_to_string { $help = <<'HELP'; This procedure works like gimp_vectors_export_to_file() but creates a string -rather than a file. The contents are a %NUL-terminated string that holds a +rather than a file. The contents are a NUL-terminated string that holds a complete XML document. If you pass 0 as the 'vectors' argument, then all paths in the image will be exported. HELP @@ -1623,5 +1623,8 @@ CODE %exports = (app => [@procs], lib => [@procs]); $desc = 'Vectors'; +$doc_title = 'gimpvectors'; +$doc_short_desc = 'Functions for querying and manipulating vectors.'; +$doc_long_desc = 'Functions for querying and manipulating vectors.'; 1; diff --git a/tools/pdbgen/pdbgen.pl b/tools/pdbgen/pdbgen.pl index 57cd1e7df1..6c399fcc60 100755 --- a/tools/pdbgen/pdbgen.pl +++ b/tools/pdbgen/pdbgen.pl @@ -69,7 +69,8 @@ $evalcode = <<'CODE'; $deprecated @inargs @outargs %invoke $canonical_name); # These are attached to the group structure - my @groupvars = qw($desc @headers %extra); + my @groupvars = qw($desc $doc_title $doc_short_desc $doc_long_desc + @headers %extra); # Hook some variables into the top-level namespace *pdb = \%main::pdb;