[gimp] libgimp: move docs from template files to inline comments
- From: Michael Natterer <mitch src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp] libgimp: move docs from template files to inline comments
- Date: Wed, 7 Jul 2010 09:50:18 +0000 (UTC)
commit c78e4c8d631fbe05f0ecbb4e01792fc48b9fa417
Author: Michael Natterer <mitch gimp org>
Date: Wed Jul 7 11:48:10 2010 +0200
libgimp: move docs from template files to inline comments
Also split up the "tools" docs into separate files so it matches
the new autogenerated PDB section headers.
devel-docs/libgimp/.gitignore | 1 +
devel-docs/libgimp/libgimp-docs.sgml | 4 +-
devel-docs/libgimp/libgimp-sections.txt | 30 +-
devel-docs/libgimp/tmpl/.gitignore | 2 -
devel-docs/libgimp/tmpl/gimp.sgml | 466 -----------
devel-docs/libgimp/tmpl/gimpaspectpreview.sgml | 40 -
devel-docs/libgimp/tmpl/gimpbrush.sgml | 238 ------
devel-docs/libgimp/tmpl/gimpbrushes.sgml | 124 ---
devel-docs/libgimp/tmpl/gimpbrushmenu.sgml | 54 --
devel-docs/libgimp/tmpl/gimpbrushselect.sgml | 94 ---
devel-docs/libgimp/tmpl/gimpbrushselectbutton.sgml | 102 ---
devel-docs/libgimp/tmpl/gimpbuffer.sgml | 84 --
devel-docs/libgimp/tmpl/gimpchannel.sgml | 124 ---
devel-docs/libgimp/tmpl/gimpcolor.sgml | 204 -----
devel-docs/libgimp/tmpl/gimpcontext.sgml | 233 ------
devel-docs/libgimp/tmpl/gimpconvert.sgml | 65 --
devel-docs/libgimp/tmpl/gimpdisplay.sgml | 74 --
devel-docs/libgimp/tmpl/gimpdrawable.sgml | 552 -------------
devel-docs/libgimp/tmpl/gimpdrawablepreview.sgml | 58 --
devel-docs/libgimp/tmpl/gimpdrawabletransform.sgml | 297 -------
devel-docs/libgimp/tmpl/gimpedit.sgml | 193 -----
devel-docs/libgimp/tmpl/gimpenums.sgml | 232 ------
devel-docs/libgimp/tmpl/gimpexport.sgml | 86 --
devel-docs/libgimp/tmpl/gimpfileops.sgml | 140 ----
devel-docs/libgimp/tmpl/gimpfloatingsel.sgml | 77 --
devel-docs/libgimp/tmpl/gimpfontmenu.sgml | 48 --
devel-docs/libgimp/tmpl/gimpfonts.sgml | 37 -
devel-docs/libgimp/tmpl/gimpfontselect.sgml | 79 --
devel-docs/libgimp/tmpl/gimpfontselectbutton.sgml | 72 --
devel-docs/libgimp/tmpl/gimpgimprc.sgml | 89 --
devel-docs/libgimp/tmpl/gimpgradient.sgml | 367 ---------
devel-docs/libgimp/tmpl/gimpgradientmenu.sgml | 48 --
devel-docs/libgimp/tmpl/gimpgradients.sgml | 89 --
devel-docs/libgimp/tmpl/gimpgradientselect.sgml | 83 --
.../libgimp/tmpl/gimpgradientselectbutton.sgml | 74 --
devel-docs/libgimp/tmpl/gimpgrid.sgml | 122 ---
devel-docs/libgimp/tmpl/gimpguides.sgml | 80 --
devel-docs/libgimp/tmpl/gimphelp.sgml | 30 -
devel-docs/libgimp/tmpl/gimpimage.sgml | 859 --------------------
devel-docs/libgimp/tmpl/gimpimagecombobox.sgml | 45 -
devel-docs/libgimp/tmpl/gimpitemcombobox.sgml | 106 ---
devel-docs/libgimp/tmpl/gimplayer.sgml | 342 --------
devel-docs/libgimp/tmpl/gimpmenu.sgml | 87 --
devel-docs/libgimp/tmpl/gimpmessage.sgml | 46 -
devel-docs/libgimp/tmpl/gimppalette.sgml | 222 -----
devel-docs/libgimp/tmpl/gimppalettemenu.sgml | 48 --
devel-docs/libgimp/tmpl/gimppalettes.sgml | 67 --
devel-docs/libgimp/tmpl/gimppaletteselect.sgml | 79 --
.../libgimp/tmpl/gimppaletteselectbutton.sgml | 72 --
devel-docs/libgimp/tmpl/gimppaths.sgml | 184 -----
devel-docs/libgimp/tmpl/gimppattern.sgml | 45 -
devel-docs/libgimp/tmpl/gimppatternmenu.sgml | 48 --
devel-docs/libgimp/tmpl/gimppatterns.sgml | 71 --
devel-docs/libgimp/tmpl/gimppatternselect.sgml | 83 --
.../libgimp/tmpl/gimppatternselectbutton.sgml | 76 --
devel-docs/libgimp/tmpl/gimppixbuf.sgml | 83 --
devel-docs/libgimp/tmpl/gimppixelfetcher.sgml | 98 ---
devel-docs/libgimp/tmpl/gimppixelrgn.sgml | 190 -----
devel-docs/libgimp/tmpl/gimpplugin.sgml | 88 --
devel-docs/libgimp/tmpl/gimpprocbrowserdialog.sgml | 61 --
devel-docs/libgimp/tmpl/gimpproceduraldb.sgml | 138 ----
devel-docs/libgimp/tmpl/gimpprocview.sgml | 39 -
devel-docs/libgimp/tmpl/gimpprogress.sgml | 187 -----
devel-docs/libgimp/tmpl/gimpprogressbar.sgml | 34 -
devel-docs/libgimp/tmpl/gimpregioniterator.sgml | 155 ----
devel-docs/libgimp/tmpl/gimpselectbutton.sgml | 33 -
devel-docs/libgimp/tmpl/gimpselection.sgml | 199 -----
devel-docs/libgimp/tmpl/gimptextlayer.sgml | 314 -------
devel-docs/libgimp/tmpl/gimptexttool.sgml | 102 ---
devel-docs/libgimp/tmpl/gimptile.sgml | 84 --
devel-docs/libgimp/tmpl/gimptools.sgml | 466 -----------
devel-docs/libgimp/tmpl/gimpui.sgml | 68 --
devel-docs/libgimp/tmpl/gimpundo.sgml | 83 --
devel-docs/libgimp/tmpl/gimpunit.sgml | 134 ---
devel-docs/libgimp/tmpl/gimpvectors.sgml | 492 -----------
devel-docs/libgimp/tmpl/gimpzoompreview.sgml | 93 ---
libgimp/gimp.c | 14 +-
libgimp/gimp.h | 27 +-
libgimp/gimpaspectpreview.c | 11 +
libgimp/gimpbrushmenu.c | 11 +-
libgimp/gimpbrushselectbutton.c | 9 +
libgimp/gimpdrawablepreview.c | 9 +
libgimp/gimpenums.h | 9 +
libgimp/gimpexport.c | 20 +
libgimp/gimpfontmenu.c | 11 +-
libgimp/gimpfontselectbutton.c | 9 +
libgimp/gimpgradientmenu.c | 11 +-
libgimp/gimpgradientselectbutton.c | 9 +
libgimp/gimpimagecombobox.c | 17 +-
libgimp/gimpitemcombobox.c | 10 +
libgimp/gimpmenu.c | 58 +-
libgimp/gimppalettemenu.c | 11 +-
libgimp/gimppaletteselectbutton.c | 9 +
libgimp/gimppatternmenu.c | 9 +
libgimp/gimppatternselectbutton.c | 9 +
libgimp/gimppixbuf.c | 9 +
libgimp/gimppixelfetcher.c | 15 +-
libgimp/gimppixelrgn.c | 10 +
libgimp/gimpprocbrowserdialog.c | 9 +
libgimp/gimpprocview.c | 10 +
libgimp/gimpprogress.c | 8 +-
libgimp/gimpprogressbar.c | 10 +
libgimp/gimpregioniterator.c | 11 +
libgimp/gimpselectbutton.c | 10 +
libgimp/gimptile.c | 9 +
libgimp/gimpui.c | 16 +
libgimp/gimpzoompreview.c | 14 +
107 files changed, 375 insertions(+), 10442 deletions(-)
---
diff --git a/devel-docs/libgimp/.gitignore b/devel-docs/libgimp/.gitignore
index 09cb3e0..3cac992 100644
--- a/devel-docs/libgimp/.gitignore
+++ b/devel-docs/libgimp/.gitignore
@@ -12,6 +12,7 @@
/libgimp-undeclared.txt
/libgimp-undocumented.txt
/html
+/tmpl
/xml
/version
/.libs
diff --git a/devel-docs/libgimp/libgimp-docs.sgml b/devel-docs/libgimp/libgimp-docs.sgml
index 51801e3..955205c 100644
--- a/devel-docs/libgimp/libgimp-docs.sgml
+++ b/devel-docs/libgimp/libgimp-docs.sgml
@@ -59,7 +59,9 @@
<xi:include href="xml/gimptextlayer.xml" />
<xi:include href="xml/gimptexttool.xml" />
<xi:include href="xml/gimptile.xml" />
- <xi:include href="xml/gimptools.xml" />
+ <xi:include href="xml/gimppainttools.xml" />
+ <xi:include href="xml/gimpselectiontools.xml" />
+ <xi:include href="xml/gimptransformtools.xml" />
<xi:include href="xml/gimpundo.xml" />
<xi:include href="xml/gimpvectors.xml" />
</chapter>
diff --git a/devel-docs/libgimp/libgimp-sections.txt b/devel-docs/libgimp/libgimp-sections.txt
index fe9c223..f15f164 100644
--- a/devel-docs/libgimp/libgimp-sections.txt
+++ b/devel-docs/libgimp/libgimp-sections.txt
@@ -846,6 +846,7 @@ gimp_selection_combine
gimp_text_layer_new
gimp_text_layer_get_text
gimp_text_layer_set_text
+gimp_text_layer_get_markup
gimp_text_layer_get_font
gimp_text_layer_set_font
gimp_text_layer_get_font_size
@@ -895,11 +896,9 @@ gimp_tile_cache_ntiles
</SECTION>
<SECTION>
-<FILE>gimptools</FILE>
+<FILE>gimppainttools</FILE>
gimp_airbrush
gimp_airbrush_default
-gimp_by_color_select
-gimp_by_color_select_full
gimp_clone
gimp_clone_default
gimp_convolve
@@ -907,26 +906,37 @@ gimp_convolve_default
gimp_dodgeburn
gimp_dodgeburn_default
gimp_edit_bucket_fill_full
-gimp_ellipse_select
gimp_eraser
gimp_eraser_default
-gimp_flip
-gimp_free_select
-gimp_fuzzy_select
-gimp_fuzzy_select_full
gimp_heal
gimp_heal_default
gimp_paintbrush
gimp_paintbrush_default
gimp_pencil
gimp_perspective
+gimp_smudge
+gimp_smudge_default
+</SECTION>
+
+<SECTION>
+<FILE>gimpselectiontools</FILE>
+gimp_by_color_select
+gimp_by_color_select_full
+gimp_ellipse_select
+gimp_free_select
+gimp_fuzzy_select
+gimp_fuzzy_select_full
gimp_rect_select
gimp_round_rect_select
+</SECTION>
+
+<SECTION>
+<FILE>gimptransformtools</FILE>
+gimp_flip
+gimp_perspective
gimp_rotate
gimp_scale
gimp_shear
-gimp_smudge
-gimp_smudge_default
gimp_transform_2d
</SECTION>
diff --git a/libgimp/gimp.c b/libgimp/gimp.c
index e949e75..66de18f 100644
--- a/libgimp/gimp.c
+++ b/libgimp/gimp.c
@@ -105,6 +105,17 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimp
+ * @title: Gimp
+ * @short_description: Main functions needed for building a GIMP plug-in.
+ * This header includes all other GIMP Library headers.
+ *
+ * Main functions needed for building a GIMP plug-in. This header
+ * includes all other GIMP Library headers.
+ **/
+
+
#define TILE_MAP_SIZE (_tile_width * _tile_height * 4)
#define ERRMSG_SHM_FAILED "Could not attach to gimp shared memory segment"
@@ -222,7 +233,8 @@ static gchar *pdb_error_message = NULL;
* The main procedure that must be called with the PLUG_IN_INFO structure
* and the 'argc' and 'argv' that are passed to "main".
*
- * Return value:
+ * Returns: an exit status as defined by the C library,
+ * on success %EXIT_SUCCESS.
**/
gint
gimp_main (const GimpPlugInInfo *info,
diff --git a/libgimp/gimp.h b/libgimp/gimp.h
index 9783321..2c21ff7 100644
--- a/libgimp/gimp.h
+++ b/libgimp/gimp.h
@@ -80,23 +80,21 @@ typedef void (* GimpRunProc) (const gchar *name,
GimpParam **return_vals);
+/**
+ * GimpPlugInInfo:
+ * @init_proc: called when the gimp application initially starts up
+ * @quit_proc: called when the gimp application exits
+ * @query_proc: called by gimp so that the plug-in can inform the
+ * gimp of what it does. (ie. installing a procedure database
+ * procedure).
+ * @run_proc: called to run a procedure the plug-in installed in the
+ * procedure database.
+ **/
struct _GimpPlugInInfo
{
- /* called when the gimp application initially starts up */
GimpInitProc init_proc;
-
- /* called when the gimp application exits */
GimpQuitProc quit_proc;
-
- /* called by gimp so that the plug-in can inform the
- * gimp of what it does. (ie. installing a procedure database
- * procedure).
- */
GimpQueryProc query_proc;
-
- /* called to run a procedure the plug-in installed in the
- * procedure database.
- */
GimpRunProc run_proc;
};
@@ -155,15 +153,14 @@ struct _GimpParam
/**
- * MAIN():
+ * MAIN:
*
* A macro that expands to the appropriate main() function for the
* platform being compiled for.
*
* To use this macro, simply place a line that contains just the code
* MAIN() at the toplevel of your file. No semicolon should be used.
- *
- */
+ **/
#ifdef G_OS_WIN32
diff --git a/libgimp/gimpaspectpreview.c b/libgimp/gimpaspectpreview.c
index 26b9f86..95c4e95 100644
--- a/libgimp/gimpaspectpreview.c
+++ b/libgimp/gimpaspectpreview.c
@@ -33,6 +33,15 @@
#include "gimpaspectpreview.h"
+/**
+ * SECTION: gimpaspectpreview
+ * @title: GimpAspectPreview
+ * @short_description: A widget providing a preview with fixed aspect ratio.
+ *
+ * A widget providing a preview with fixed aspect ratio.
+ **/
+
+
enum
{
PROP_0,
@@ -374,6 +383,8 @@ gimp_aspect_preview_set_drawable (GimpAspectPreview *preview,
* the scroll offset.
*
* Since: GIMP 2.2
+ *
+ * Returns: a new #GimpAspectPreview.
**/
GtkWidget *
gimp_aspect_preview_new (GimpDrawable *drawable,
diff --git a/libgimp/gimpbrushmenu.c b/libgimp/gimpbrushmenu.c
index 43fcbe4..d1030a0 100644
--- a/libgimp/gimpbrushmenu.c
+++ b/libgimp/gimpbrushmenu.c
@@ -32,6 +32,15 @@
#include "gimpbrushmenu.h"
+/**
+ * SECTION: gimpbrushmenu
+ * @title: gimpbrushmenu
+ * @short_description: A widget for selecting brushes.
+ *
+ * A widget for selecting brushes.
+ **/
+
+
typedef struct
{
GimpRunBrushCallback callback;
@@ -113,7 +122,7 @@ gimp_brush_select_widget_close (GtkWidget *widget)
}
/**
- * gimp_brush_select_widget_set;
+ * gimp_brush_select_widget_set:
* @widget: A brush select widget.
* @brush_name: Brush name to set; %NULL means no change.
* @opacity: Opacity to set. -1.0 means no change.
diff --git a/libgimp/gimpbrushselectbutton.c b/libgimp/gimpbrushselectbutton.c
index 4743407..8480e0b 100644
--- a/libgimp/gimpbrushselectbutton.c
+++ b/libgimp/gimpbrushselectbutton.c
@@ -34,6 +34,15 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimpbrushselectbutton
+ * @title: gimpbrushselectbutton
+ * @short_description: A button that pops up a brush selection dialog.
+ *
+ * A button that pops up a brush selection dialog.
+ **/
+
+
#define CELL_SIZE 20
diff --git a/libgimp/gimpdrawablepreview.c b/libgimp/gimpdrawablepreview.c
index 6632d3c..5f3aeaf 100644
--- a/libgimp/gimpdrawablepreview.c
+++ b/libgimp/gimpdrawablepreview.c
@@ -31,6 +31,15 @@
#include "gimpdrawablepreview.h"
+/**
+ * SECTION: gimpdrawablepreview
+ * @title: GimpDrawablePreview
+ * @short_description: A widget providing a preview of a #GimpDrawable.
+ *
+ * A widget providing a preview of a #GimpDrawable.
+ **/
+
+
#define SELECTION_BORDER 8
enum
diff --git a/libgimp/gimpenums.h b/libgimp/gimpenums.h
index d52c978..8b5035c 100644
--- a/libgimp/gimpenums.h
+++ b/libgimp/gimpenums.h
@@ -24,6 +24,15 @@
G_BEGIN_DECLS
+/**
+ * SECTION: gimpenums
+ * @title: gimpenums
+ * @short_description: Enums and definitions.
+ *
+ * Enums and definitions.
+ **/
+
+
#define GIMP_TYPE_BRUSH_APPLICATION_MODE (gimp_brush_application_mode_get_type ())
GType gimp_brush_application_mode_get_type (void) G_GNUC_CONST;
diff --git a/libgimp/gimpexport.c b/libgimp/gimpexport.c
index 45e125e..03f59ed 100644
--- a/libgimp/gimpexport.c
+++ b/libgimp/gimpexport.c
@@ -31,6 +31,26 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimpexport
+ * @title: gimpexport
+ * @short_description: Export an image before it is saved.
+ *
+ * This function should be called by all save_plugins unless they are
+ * able to save all image formats GIMP knows about. It takes care of
+ * asking the user if she wishes to export the image to a format the
+ * save_plugin can handle. It then performs the necessary conversions
+ * (e.g. Flatten) on a copy of the image so that the image can be
+ * saved without changing the original image.
+ *
+ * The capabilities of the save_plugin are specified by combining
+ * #GimpExportCapabilities using a bitwise OR.
+ *
+ * Make sure you have initialized GTK+ before you call this function
+ * as it will most probably have to open a dialog.
+ **/
+
+
typedef void (* ExportFunc) (gint32 imageID,
gint32 *drawable_ID);
diff --git a/libgimp/gimpfontmenu.c b/libgimp/gimpfontmenu.c
index 5477ffd..4588838 100644
--- a/libgimp/gimpfontmenu.c
+++ b/libgimp/gimpfontmenu.c
@@ -32,6 +32,15 @@
#include "gimpfontmenu.h"
+/**
+ * SECTION: gimpfontmenu
+ * @title: gimpfontmenu
+ * @short_description: A widget for selecting fonts.
+ *
+ * A widget for selecting fonts.
+ **/
+
+
typedef struct
{
GimpRunFontCallback callback;
@@ -100,7 +109,7 @@ gimp_font_select_widget_close (GtkWidget *widget)
}
/**
- * gimp_font_select_widget_set;
+ * gimp_font_select_widget_set:
* @widget: A font select widget.
* @font_name: Font name to set; %NULL means no change.
*
diff --git a/libgimp/gimpfontselectbutton.c b/libgimp/gimpfontselectbutton.c
index a94494b..a51ed41 100644
--- a/libgimp/gimpfontselectbutton.c
+++ b/libgimp/gimpfontselectbutton.c
@@ -34,6 +34,15 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimpfontselectbutton
+ * @title: GimpFontSelectButton
+ * @short_description: A button which pops up a font selection dialog.
+ *
+ * A button which pops up a font selection dialog.
+ **/
+
+
#define GIMP_FONT_SELECT_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GIMP_TYPE_FONT_SELECT_BUTTON, GimpFontSelectButtonPrivate))
typedef struct _GimpFontSelectButtonPrivate GimpFontSelectButtonPrivate;
diff --git a/libgimp/gimpgradientmenu.c b/libgimp/gimpgradientmenu.c
index f638d2b..d116953 100644
--- a/libgimp/gimpgradientmenu.c
+++ b/libgimp/gimpgradientmenu.c
@@ -32,6 +32,15 @@
#include "gimpgradientmenu.h"
+/**
+ * SECTION: gimpgradientmenu
+ * @title: gimpgradientmenu
+ * @short_description: A widget for selecting gradients.
+ *
+ * A widget for selecting gradients.
+ **/
+
+
typedef struct
{
GimpRunGradientCallback callback;
@@ -104,7 +113,7 @@ gimp_gradient_select_widget_close (GtkWidget *widget)
}
/**
- * gimp_gradient_select_widget_set;
+ * gimp_gradient_select_widget_set:
* @widget: A gradient select widget.
* @gradient_name: Gradient name to set.
*
diff --git a/libgimp/gimpgradientselectbutton.c b/libgimp/gimpgradientselectbutton.c
index 3c8d439..1085830 100644
--- a/libgimp/gimpgradientselectbutton.c
+++ b/libgimp/gimpgradientselectbutton.c
@@ -34,6 +34,15 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimpgradientselectbutton
+ * @title: GimpGradientSelectButton
+ * @short_description: A button which pops up a gradient select dialog.
+ *
+ * A button which pops up a gradient select dialog.
+ **/
+
+
#define CELL_HEIGHT 18
#define CELL_WIDTH 84
diff --git a/libgimp/gimpimagecombobox.c b/libgimp/gimpimagecombobox.c
index 7e0b912..55533c7 100644
--- a/libgimp/gimpimagecombobox.c
+++ b/libgimp/gimpimagecombobox.c
@@ -34,6 +34,15 @@
#include "gimppixbuf.h"
+/**
+ * SECTION: gimpimagecombobox
+ * @title: GimpImageComboBox
+ * @short_description: A widget providing a popup menu of images.
+ *
+ * A widget providing a popup menu of images.
+ **/
+
+
#define THUMBNAIL_SIZE 24
#define WIDTH_REQUEST 200
@@ -101,10 +110,10 @@ gimp_image_combo_box_init (GimpImageComboBox *combo_box)
* each image and only if the function returns %TRUE, the image is
* added to the combobox.
*
- * You should use gimp_int_combo_connect() to initialize and connect
- * the combo. Use gimp_int_combo_box_set_active() to get the active
- * image ID and gimp_int_combo_box_get_active() to retrieve the ID of
- * the selected image.
+ * You should use gimp_int_combo_box_connect() to initialize and
+ * connect the combo. Use gimp_int_combo_box_set_active() to get the
+ * active image ID and gimp_int_combo_box_get_active() to retrieve the
+ * ID of the selected image.
*
* Return value: a new #GimpIntComboBox.
*
diff --git a/libgimp/gimpitemcombobox.c b/libgimp/gimpitemcombobox.c
index 3351f88..02f5552 100644
--- a/libgimp/gimpitemcombobox.c
+++ b/libgimp/gimpitemcombobox.c
@@ -35,6 +35,16 @@
#include "gimppixbuf.h"
+/**
+ * SECTION: gimpitemcombobox
+ * @title: GimpItemComboBox
+ * @short_description: Widgets providing popup menus of items.
+ *
+ * Widgets providing popup menus of items (layers, channels,
+ * drawables, vectors).
+ **/
+
+
#define THUMBNAIL_SIZE 24
#define WIDTH_REQUEST 200
diff --git a/libgimp/gimpmenu.c b/libgimp/gimpmenu.c
index 82a65af..81b1dd7 100644
--- a/libgimp/gimpmenu.c
+++ b/libgimp/gimpmenu.c
@@ -32,6 +32,16 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimpmenu
+ * @title: gimpmenu
+ * @short_description: Menus for selecting images, layers, channels
+ * and drawables.
+ *
+ * Menus for selecting images, layers, channels and drawables.
+ **/
+
+
#define MENU_THUMBNAIL_WIDTH 24
#define MENU_THUMBNAIL_HEIGHT 24
@@ -57,14 +67,14 @@ static void gimp_menu_callback (GtkWidget *widget,
/**
* gimp_image_menu_new:
- * @constraint:
- * @callback:
- * @data:
- * @active_image:
+ * @constraint: a function to filter the menu contents
+ * @callback: the callback to call when an image is selected
+ * @data: the callback's user_data
+ * @active_image: an image to preselect
*
- * Use gimp_image_combo_box_new() instead.
+ * Deprecated: Use gimp_image_combo_box_new() instead.
*
- * Return value:
+ * Returns: the image menu.
*/
GtkWidget *
gimp_image_menu_new (GimpConstraintFunc constraint,
@@ -122,14 +132,14 @@ gimp_image_menu_new (GimpConstraintFunc constraint,
/**
* gimp_layer_menu_new:
- * @constraint:
- * @callback:
- * @data:
- * @active_layer:
+ * @constraint: a function to filter the menu contents
+ * @callback: the callback to call when a channel is selected
+ * @data: the callback's user_data
+ * @active_layer: a layer to preselect
*
- * Use gimp_layer_combo_box_new() instead.
+ * Deprecated: Use gimp_layer_combo_box_new() instead.
*
- * Return value:
+ * Returns: the layer menu.
*/
GtkWidget *
gimp_layer_menu_new (GimpConstraintFunc constraint,
@@ -199,14 +209,14 @@ gimp_layer_menu_new (GimpConstraintFunc constraint,
/**
* gimp_channel_menu_new:
- * @constraint:
- * @callback:
- * @data:
- * @active_channel:
+ * @constraint: a function to filter the menu contents
+ * @callback: the callback to call when a channel is selected
+ * @data: the callback's user_data
+ * @active_channel: a channel to preselect
*
- * Use gimp_channel_combo_box_new() instead.
+ * Deprecated: Use gimp_channel_combo_box_new() instead.
*
- * Return value:
+ * Returns: the channel menu.
*/
GtkWidget *
gimp_channel_menu_new (GimpConstraintFunc constraint,
@@ -278,14 +288,14 @@ gimp_channel_menu_new (GimpConstraintFunc constraint,
/**
* gimp_drawable_menu_new:
- * @constraint:
- * @callback:
- * @data:
- * @active_drawable:
+ * @constraint: a function to filter the menu contents
+ * @callback: the callback to call when a channel is selected
+ * @data: the callback's user_data
+ * @active_drawable: a drawable to preselect
*
- * Use gimp_drawable_combo_box_new() instead.
+ * Deprecated: Use gimp_drawable_combo_box_new() instead.
*
- * Return value:
+ * Returns: the drawable menu.
*/
GtkWidget *
gimp_drawable_menu_new (GimpConstraintFunc constraint,
diff --git a/libgimp/gimppalettemenu.c b/libgimp/gimppalettemenu.c
index ba69ef1..4c310b5 100644
--- a/libgimp/gimppalettemenu.c
+++ b/libgimp/gimppalettemenu.c
@@ -32,6 +32,15 @@
#include "gimppalettemenu.h"
+/**
+ * SECTION: gimppalettemenu
+ * @title: gimppalettemenu
+ * @short_description: A widget for selecting palettes.
+ *
+ * A widget for selecting palettes.
+ **/
+
+
typedef struct
{
GimpRunPaletteCallback callback;
@@ -104,7 +113,7 @@ gimp_palette_select_widget_close (GtkWidget *widget)
}
/**
- * gimp_palette_select_widget_set;
+ * gimp_palette_select_widget_set:
* @widget: A palette select widget.
* @palette_name: Palette name to set; %NULL means no change.
*
diff --git a/libgimp/gimppaletteselectbutton.c b/libgimp/gimppaletteselectbutton.c
index 583a79b..0178d4e 100644
--- a/libgimp/gimppaletteselectbutton.c
+++ b/libgimp/gimppaletteselectbutton.c
@@ -34,6 +34,15 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimppaletteselectbutton
+ * @title: GimpPaletteSelect
+ * @short_description: A button which pops up a palette select dialog.
+ *
+ * A button which pops up a palette select dialog.
+ **/
+
+
#define GIMP_PALETTE_SELECT_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GIMP_TYPE_PALETTE_SELECT_BUTTON, GimpPaletteSelectButtonPrivate))
typedef struct _GimpPaletteSelectButtonPrivate GimpPaletteSelectButtonPrivate;
diff --git a/libgimp/gimppatternmenu.c b/libgimp/gimppatternmenu.c
index 9c99b77..8c348f9 100644
--- a/libgimp/gimppatternmenu.c
+++ b/libgimp/gimppatternmenu.c
@@ -32,6 +32,15 @@
#include "gimppatternmenu.h"
+/**
+ * SECTION: gimppatternmenu
+ * @title: gimppatternmenu
+ * @short_description: A widget for selecting patterns.
+ *
+ * A widget for selecting patterns.
+ **/
+
+
typedef struct
{
GimpRunPatternCallback callback;
diff --git a/libgimp/gimppatternselectbutton.c b/libgimp/gimppatternselectbutton.c
index 2286169..9878a38 100644
--- a/libgimp/gimppatternselectbutton.c
+++ b/libgimp/gimppatternselectbutton.c
@@ -34,6 +34,15 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimppatternselectbutton
+ * @title: GimpPatternSelectButton
+ * @short_description: A button which pops up a pattern select dialog.
+ *
+ * A button which pops up a pattern select dialog.
+ **/
+
+
#define CELL_SIZE 20
diff --git a/libgimp/gimppixbuf.c b/libgimp/gimppixbuf.c
index 8861bda..77b13d1 100644
--- a/libgimp/gimppixbuf.c
+++ b/libgimp/gimppixbuf.c
@@ -30,6 +30,15 @@
#include "gimppixbuf.h"
+/**
+ * SECTION: gimppixbuf
+ * @title: gimppixbuf
+ * @short_description: Get a thumbnail pixbuf for a drawable or image.
+ *
+ * Get a thumbnail pixbuf for a drawable or image.
+ **/
+
+
static GdkPixbuf * gimp_pixbuf_from_data (guchar *data,
gint width,
gint height,
diff --git a/libgimp/gimppixelfetcher.c b/libgimp/gimppixelfetcher.c
index df6da52..9850c66 100644
--- a/libgimp/gimppixelfetcher.c
+++ b/libgimp/gimppixelfetcher.c
@@ -23,6 +23,19 @@
#include "gimp.h"
+/**
+ * SECTION: gimppixelfetcher
+ * @title: gimppixelfetcher
+ * @short_description: Functions for operating on pixel regions.
+ *
+ * These functions provide neighbourhood-based algorithms which get
+ * dramatically slower on region boundaries, to the point where a
+ * special treatment for neighbourhoods which are completely inside a
+ * tile is called for. It hides the special treatment of tile borders,
+ * making plug-in code more readable and shorter.
+ **/
+
+
struct _GimpPixelFetcher
{
gint col, row;
@@ -53,7 +66,7 @@ static guchar * gimp_pixel_fetcher_provide_tile (GimpPixelFetcher *pf,
* gimp_pixel_fetcher_new:
* @drawable: the #GimpDrawable the new region will be attached to.
* @shadow: a #gboolean indicating whether the region is attached to
- * the shadow tiles or the real %drawable tiles.
+ * the shadow tiles or the real @drawable tiles.
*
* Initialize a pixel region from the drawable.
*
diff --git a/libgimp/gimppixelrgn.c b/libgimp/gimppixelrgn.c
index 8fe5156..587812c 100644
--- a/libgimp/gimppixelrgn.c
+++ b/libgimp/gimppixelrgn.c
@@ -26,6 +26,16 @@
#include "gimp.h"
+/**
+ * SECTION: gimppixelrgn
+ * @title: gimppixelrgn
+ * @short_description: Functions for operating on pixel regions.
+ *
+ * Functions for operating on pixel regions. These functions provide
+ * fast ways of accessing and modifying portions of a drawable.
+ **/
+
+
#define TILE_WIDTH gimp_tile_width()
#define TILE_HEIGHT gimp_tile_height()
diff --git a/libgimp/gimpprocbrowserdialog.c b/libgimp/gimpprocbrowserdialog.c
index 85e33c8..4cf4d86 100644
--- a/libgimp/gimpprocbrowserdialog.c
+++ b/libgimp/gimpprocbrowserdialog.c
@@ -35,6 +35,15 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimpprocbrowserdialog
+ * @title: GimpProcBrowserDialog
+ * @short_description: The dialog for the procedure and plugin browsers.
+ *
+ * The dialog for the procedure and plugin browsers.
+ **/
+
+
#define DBL_LIST_WIDTH 250
#define DBL_WIDTH (DBL_LIST_WIDTH + 400)
#define DBL_HEIGHT 250
diff --git a/libgimp/gimpprocview.c b/libgimp/gimpprocview.c
index 2f294cb..d411bca 100644
--- a/libgimp/gimpprocview.c
+++ b/libgimp/gimpprocview.c
@@ -41,6 +41,16 @@
#include "libgimp-intl.h"
+/**
+ * SECTION: gimpprocview
+ * @title: GimpProcView
+ * @short_description: A widget showing information about a PDB procedure.
+ *
+ * A widget showing information about a PDB procedure, mainly for the
+ * procedure and plug-in browsers.
+ **/
+
+
/* local function prototypes */
static GtkWidget * gimp_proc_view_create_params (const GimpParamDef *params,
diff --git a/libgimp/gimpprogress.c b/libgimp/gimpprogress.c
index 98fea6c..3e7807d 100644
--- a/libgimp/gimpprogress.c
+++ b/libgimp/gimpprogress.c
@@ -65,14 +65,14 @@ static const gdouble gimp_progress_step = (1.0 / 256.0);
* @value_callback: the function to call to change the value
* @user_data: a pointer that is returned when uninstalling the progress
*
- * Return value: the name of the temporary procedure that's been installed
- *
- * Since: GIMP 2.2
- *
* Note that since GIMP 2.4, @value_callback can be called with
* negative values. This is triggered by calls to gimp_progress_pulse().
* The callback should then implement a progress indicating business,
* e.g. by calling gtk_progress_bar_pulse().
+ *
+ * Return value: the name of the temporary procedure that's been installed
+ *
+ * Since: GIMP 2.2
**/
const gchar *
gimp_progress_install (GimpProgressStartCallback start_callback,
diff --git a/libgimp/gimpprogressbar.c b/libgimp/gimpprogressbar.c
index a12365b..ceb54f1 100644
--- a/libgimp/gimpprogressbar.c
+++ b/libgimp/gimpprogressbar.c
@@ -38,6 +38,16 @@
#include "gimpprogressbar.h"
+/**
+ * SECTION: gimpprogressbar
+ * @title: GimpProgressBar
+ * @short_description: A widget providing a progress bar.
+ *
+ * A widget providing a progress bar that automatically redirects any
+ * progress calls to itself.
+ **/
+
+
static void gimp_progress_bar_destroy (GtkObject *object);
static void gimp_progress_bar_start (const gchar *message,
diff --git a/libgimp/gimpregioniterator.c b/libgimp/gimpregioniterator.c
index cf40177..d1c4bfe 100644
--- a/libgimp/gimpregioniterator.c
+++ b/libgimp/gimpregioniterator.c
@@ -26,6 +26,17 @@
#include "gimpregioniterator.h"
+/**
+ * SECTION: gimpregioniterator
+ * @title: gimpregioniterator
+ * @short_description: Functions to traverse a pixel regions.
+ *
+ * The GimpRgnIterator functions provide a variety of common ways to
+ * traverse a PixelRegion, using a pre-defined function pointer per
+ * pixel.
+ **/
+
+
struct _GimpRgnIterator
{
GimpDrawable *drawable;
diff --git a/libgimp/gimpselectbutton.c b/libgimp/gimpselectbutton.c
index 3bdc1ac..cd48017 100644
--- a/libgimp/gimpselectbutton.c
+++ b/libgimp/gimpselectbutton.c
@@ -29,6 +29,16 @@
#include "gimpselectbutton.h"
+/**
+ * SECTION: gimpselectbutton
+ * @title: GimpSelectButton
+ * @short_description: The base class of the data select buttons.
+ *
+ * The base class of the brush, pattern, gradient, palette and font
+ * select buttons.
+ **/
+
+
/* local function prototypes */
static void gimp_select_button_destroy (GtkObject *object);
diff --git a/libgimp/gimptile.c b/libgimp/gimptile.c
index 85dba17..ee0a5f4 100644
--- a/libgimp/gimptile.c
+++ b/libgimp/gimptile.c
@@ -31,6 +31,15 @@
#include "gimp.h"
+/**
+ * SECTION: gimptile
+ * @title: gimptile
+ * @short_description: Functions for working with tiles.
+ *
+ * Functions for working with tiles.
+ **/
+
+
/* This is the percentage of the maximum cache size that
* should be cleared from the cache when an eviction is
* necessary.
diff --git a/libgimp/gimpui.c b/libgimp/gimpui.c
index ce81f04..c2671ee 100644
--- a/libgimp/gimpui.c
+++ b/libgimp/gimpui.c
@@ -29,6 +29,21 @@
#include "libgimpwidgets/gimpwidgets-private.h"
+/**
+ * SECTION: gimpui
+ * @title: gimpui
+ * @short_description: Common user interface functions. This header includes
+ * all other GIMP User Interface Library headers.
+ * @see_also: gtk_init(), gdk_set_use_xshm(), gdk_rgb_set_min_colors(),
+ * gdk_rgb_set_install(), gdk_rgb_get_visual(),
+ * gdk_rgb_get_cmap(), gtk_widget_set_default_visual(),
+ * gtk_widget_set_default_colormap(), gtk_preview_set_gamma().
+ *
+ * Common user interface functions. This header includes all other
+ * GIMP User Interface Library headers.
+ **/
+
+
/* local function prototypes */
static void gimp_ui_help_func (const gchar *help_id,
@@ -129,6 +144,7 @@ gimp_ui_init (const gchar *prog_name,
/**
* gimp_ui_get_display_window:
+ * @gdisp_ID: a #GimpDisplay ID.
*
* Returns the #GdkWindow of a display window. The purpose is to allow
* to make plug-in dialogs transient to the image display as explained
diff --git a/libgimp/gimpzoompreview.c b/libgimp/gimpzoompreview.c
index 5f285c6..6b4a4f7 100644
--- a/libgimp/gimpzoompreview.c
+++ b/libgimp/gimpzoompreview.c
@@ -33,6 +33,15 @@
#include "gimpzoompreview.h"
+/**
+ * SECTION: gimpzoompreview
+ * @title: GimpZoomPreview
+ * @short_description: A drawable preview with zooming capabilities.
+ *
+ * A drawable preview with zooming capabilities.
+ **/
+
+
enum
{
PROP_0,
@@ -40,6 +49,7 @@ enum
PROP_MODEL
};
+
typedef struct GimpZoomPreviewPrivate
{
GimpDrawable *drawable;
@@ -734,6 +744,8 @@ gimp_zoom_preview_get_source_area (GimpPreview *preview,
* Creates a new #GimpZoomPreview widget for @drawable.
*
* Since: GIMP 2.4
+ *
+ * Returns: a new #GimpZoomPreview.
**/
GtkWidget *
gimp_zoom_preview_new (GimpDrawable *drawable)
@@ -759,6 +771,8 @@ gimp_zoom_preview_new (GimpDrawable *drawable)
* factor in sync.
*
* Since: GIMP 2.4
+ *
+ * Returns: a new #GimpZoomPreview.
**/
GtkWidget *
gimp_zoom_preview_new_with_model (GimpDrawable *drawable,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
