tools: add pdbgen support for generating gtk-doc SECTION comments

Add the new $doc_title, $doc_short_desc and $doc_long_desc strings to
all .pdb files.
This commit is contained in:
Michael Natterer 2010-07-07 11:43:10 +02:00
parent 6739f6266c
commit 3a2cd14382
96 changed files with 633 additions and 3 deletions

View File

@ -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.

View File

@ -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:
*

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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:
*

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -24,6 +24,16 @@
#include "gimp.h"
/**
* SECTION: gimpfonts
* @title: gimpfonts
* @short_description: Operations related to fonts.
*
* Operations related to fonts.
**/
/**
* gimp_fonts_refresh:
*

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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:
*

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -24,6 +24,16 @@
#include "gimp.h"
/**
* SECTION: gimpmisc
* @title: gimpmisc
* @short_description: Miscellaneous procedures
*
* Miscellaneous procedures not fitting in any category.
**/
/**
* gimp_version:
*

View File

@ -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.

View File

@ -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.

View File

@ -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:
*

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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:
*

View File

@ -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.

View File

@ -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).

View File

@ -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:
*

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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:
*

View File

@ -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.
*

View File

@ -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 <<SECTION_DOCS;
/**
* SECTION: $main::grp{$group}->{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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;

View File

@ -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;