Commit 3a2cd143 authored by Michael Natterer's avatar Michael Natterer 😴

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.
parent 6739f626
......@@ -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.
......
......@@ -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:
*
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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:
*
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -24,6 +24,16 @@
#include "gimp.h"
/**
* SECTION: gimpfonts
* @title: gimpfonts
* @short_description: Operations related to fonts.
*
* Operations related to fonts.
**/
/**
* gimp_fonts_refresh:
*
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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:
*
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -24,6 +24,16 @@
#include "gimp.h"
/**
* SECTION: gimpmisc
* @title: gimpmisc
* @short_description: Miscellaneous procedures
*
* Miscellaneous procedures not fitting in any category.
**/
/**
* gimp_version:
*
......
......@@ -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.
......
......@@ -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.
......
......@@ -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:
*
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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:
*
......
......@@ -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.
......
......@@ -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).
......
......@@ -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:
*
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.