GNOME.org
 

[gimp] libgimpbase: "document" the remaining enums in libgimpbase

commit 272ac3ba8f8ee940a3bfde1c64edd6c7795502ae
Author: Michael Natterer <mitch gimp org>
Date:   Sun May 20 16:37:04 2018 +0200

    libgimpbase: "document" the remaining enums in libgimpbase
    
    As before, these are mostly just skeletons.

 libgimpbase/gimpbaseenums.h |  357 ++++++++++++++++++++++++++++++++++++++++---
 libgimpbase/gimpcpuaccel.h  |   17 ++
 libgimpbase/gimpmetadata.h  |   33 ++++
 3 files changed, 388 insertions(+), 19 deletions(-)
---
diff --git a/libgimpbase/gimpbaseenums.h b/libgimpbase/gimpbaseenums.h
index 5260af0..655e3ae 100644
--- a/libgimpbase/gimpbaseenums.h
+++ b/libgimpbase/gimpbaseenums.h
@@ -43,13 +43,14 @@ G_BEGIN_DECLS
  * @GIMP_ADD_MASK_SELECTION:       Selection
  * @GIMP_ADD_MASK_COPY:            Grayscale copy of layer
  * @GIMP_ADD_MASK_CHANNEL:         Channel
- * @GIMP_ADD_WHITE_MASK:           Deprecated alias
- * @GIMP_ADD_BLACK_MASK:           Deprecated alias
- * @GIMP_ADD_ALPHA_MASK:           Deprecated alias
- * @GIMP_ADD_ALPHA_TRANSFER_MASK:  Deprecated alias
- * @GIMP_ADD_SELECTION_MASK:       Deprecated alias
- * @GIMP_ADD_COPY_MASK:            Deprecated alias
- * @GIMP_ADD_CHANNEL_MASK:         Deprecated aliaa
+ * @GIMP_ADD_WHITE_MASK:           Deprecated alias for @GIMP_ADD_MASK_WHITE
+ * @GIMP_ADD_BLACK_MASK:           Deprecated alias for @GIMP_ADD_MASK_BLACK
+ * @GIMP_ADD_ALPHA_MASK:           Deprecated alias for @GIMP_ADD_MASK_ALPHA
+ * @GIMP_ADD_ALPHA_TRANSFER_MASK:  Deprecated alias for
+ *                                 @GIMP_ADD_MASK_ALPHA_TRANSFER
+ * @GIMP_ADD_SELECTION_MASK:       Deprecated alias for @GIMP_ADD_MASK_SELECTION
+ * @GIMP_ADD_COPY_MASK:            Deprecated alias for @GIMP_ADD_MASK_COPY
+ * @GIMP_ADD_CHANNEL_MASK:         Deprecated aliaa for @GIMP_ADD_MASK_CHANNEL
  *
  * Modes of initialising a layer mask.
  **/
@@ -85,6 +86,10 @@ typedef enum
  * @GIMP_BLEND_FG_BG_HSV:      FG to BG (HSV)
  * @GIMP_BLEND_FG_TRANSPARENT: FG to transparent
  * @GIMP_BLEND_CUSTOM:         Custom gradient
+ * @GIMP_FG_BG_RGB_MODE:       Deprecated alias for @GIMP_BLEND_FG_BG_RGB
+ * @GIMP_FG_BG_HSV_MODE:       Deprecated alias for @GIMP_BLEND_FG_BG_HSV
+ * @GIMP_FG_TRANSPARENT_MODE:  Deprecated alias for @GIMP_BLEND_FG_TRANSPARENT
+ * @GIMP_CUSTOM_MODE:          Deprecated alias for @GIMP_BLEND_CUSTOM
  *
  * Types of gradients.
  **/
@@ -133,6 +138,9 @@ typedef enum
  * @GIMP_BUCKET_FILL_FG:      FG color fill
  * @GIMP_BUCKET_FILL_BG:      BG color fill
  * @GIMP_BUCKET_FILL_PATTERN: Pattern fill
+ * @GIMP_FG_BUCKET_FILL:      Deprecated alias for @GIMP_BUCKET_FILL_FG
+ * @GIMP_BG_BUCKET_FILL:      Deprecated alias for @GIMP_BUCKET_FILL_BG
+ * @GIMP_PATTERN_BUCKET_FILL: Deprecated alias for @GIMP_BUCKET_FILL_PATTERN
  *
  * Bucket fill modes.
  */
@@ -204,6 +212,12 @@ typedef enum
  * @GIMP_CHANNEL_GRAY:    Gray
  * @GIMP_CHANNEL_INDEXED: Indexed
  * @GIMP_CHANNEL_ALPHA:   Alpha
+ * @GIMP_RED_CHANNEL:     Deprecated alias for @GIMP_CHANNEL_RED
+ * @GIMP_GREEN_CHANNEL:   Deprecated alias for @GIMP_CHANNEL_GREEN
+ * @GIMP_BLUE_CHANNEL:    Deprecated alias for @GIMP_CHANNEL_BLUE
+ * @GIMP_GRAY_CHANNEL:    Deprecated alias for @GIMP_CHANNEL_GRAY
+ * @GIMP_INDEXED_CHANNEL: Deprecated alias for @GIMP_CHANNEL_INDEXED
+ * @GIMP_ALPHA_CHANNEL:   Deprecated alias for @GIMP_CHANNEL_ALPHA
  *
  * Channels (as in color components).
  **/
@@ -279,8 +293,10 @@ typedef enum  /*< pdb-skip >*/
 
 /**
  * GimpCloneType:
- * @GIMP_CLONE_IMAGE:   Image
- * @GIMP_CLONE_PATTERN: Pattern
+ * @GIMP_CLONE_IMAGE:   Clone from an image/drawable source
+ * @GIMP_CLONE_PATTERN: Clone from a pattern source
+ * @GIMP_IMAGE_CLONE:   Deprecated alias for @GIMP_CLONE_IMAGE
+ * @GIMP_PATTERN_CLONE: Deprecated alias for @GIMP_CLONE_PATTERN
  *
  * Clone sources.
  **/
@@ -369,6 +385,16 @@ typedef enum
  * @GIMP_CONVERT_PALETTE_WEB:      Use web-optimized palette
  * @GIMP_CONVERT_PALETTE_MONO:     Use black and white (1-bit) palette
  * @GIMP_CONVERT_PALETTE_CUSTOM:   Use custom palette
+ * @GIMP_MAKE_PALETTE:             Deprecated alias for
+ *                                 @GIMP_CONVERT_PALETTE_GENERATE
+ * @GIMP_REUSE_PALETTE:            Deprecated alias for
+ *                                 @GIMP_CONVERT_PALETTE_REUSE
+ * @GIMP_WEB_PALETTE:              Deprecated alias for
+ *                                 @GIMP_CONVERT_PALETTE_WEB
+ * @GIMP_MONO_PALETTE:             Deprecated alias for
+                                   @GIMP_CONVERT_PALETTE_MONO
+ * @GIMP_CUSTOM_PALETTE:           Deprecated alias for
+ *                                 @GIMP_CONVERT_PALETTE_CUSTOM
  *
  * Types of palettes for indexed conversion.
  **/
@@ -398,6 +424,8 @@ typedef enum
  * GimpConvolveType:
  * @GIMP_CONVOLVE_BLUR:    Blur
  * @GIMP_CONVOLVE_SHARPEN: Sharpen
+ * @GIMP_BLUR_CONVOLVE:    Deprecated alias for @GIMP_CONVOLVE_BLUR
+ * @GIMP_SHARPEN_CONVOLVE: Deprecated alias for @GIMP_CONVOLVE_SHARPEN
  *
  * Types of convolutions.
  **/
@@ -419,11 +447,12 @@ typedef enum
 
 /**
  * GimpDesaturateMode:
- * @GIMP_DESATURATE_LIGHTNESS: Lightness (HSL)
- * @GIMP_DESATURATE_LUMA:      Luma
- * @GIMP_DESATURATE_AVERAGE:   Average (HSI Intensity)
- * @GIMP_DESATURATE_LUMINANCE: Luminance
- * @GIMP_DESATURATE_VALUE:     Value (HSV)
+ * @GIMP_DESATURATE_LIGHTNESS:  Lightness (HSL)
+ * @GIMP_DESATURATE_LUMA:       Luma
+ * @GIMP_DESATURATE_AVERAGE:    Average (HSI Intensity)
+ * @GIMP_DESATURATE_LUMINANCE:  Luminance
+ * @GIMP_DESATURATE_VALUE:      Value (HSV)
+ * @GIMP_DESATURATE_LUMINOSITY: Deprecated alias for @GIMP_DESATURATE_LUMA
  *
  * Grayscale conversion methods.
  **/
@@ -449,6 +478,8 @@ typedef enum
  * GimpDodgeBurnType:
  * @GIMP_DODGE_BURN_TYPE_DODGE: Dodge
  * @GIMP_DODGE_BURN_TYPE_BURN:  Burn
+ * @GIMP_DODGE:                 Deprecated alias for @GIMP_DODGE_BURN_TYPE_DODGE
+ * @GIMP_BURN:                  Deprecated alias for @GIMP_DODGE_BURN_TYPE_BURN
  *
  * Methods for the dodge/burn operation.
  **/
@@ -475,6 +506,11 @@ typedef enum
  * @GIMP_FILL_WHITE:       White
  * @GIMP_FILL_TRANSPARENT: Transparency
  * @GIMP_FILL_PATTERN:     Pattern
+ * @GIMP_FOREGROUND_FILL:  Deprecated alias for @GIMP_FILL_FOREGROUND
+ * @GIMP_BACKGROUND_FILL:  Deprecated alias for @GIMP_FILL_BACKGROUND
+ * @GIMP_WHITE_FILL:       Deprecated alias for @GIMP_FILL_WHITE
+ * @GIMP_TRANSPARENT_FILL: Deprecated alias for @GIMP_FILL_TRANSPARENT
+ * @GIMP_PATTERN_FILL:     Deprecated alias for @GIMP_FILL_PATTERN
  *
  * Types of filling.
  **/
@@ -653,6 +689,13 @@ typedef enum
  * @GIMP_HUE_RANGE_CYAN:    Cyan hues
  * @GIMP_HUE_RANGE_BLUE:    Blue hues
  * @GIMP_HUE_RANGE_MAGENTA: Magenta hues
+ * @GIMP_ALL_HUES:          Deprecated alias for @GIMP_HUE_RANGE_ALL
+ * @GIMP_RED_HUES:          Deprecated alias for @GIMP_HUE_RANGE_RED
+ * @GIMP_YELLOW_HUES:       Deprecated alias for @GIMP_HUE_RANGE_YELLOW
+ * @GIMP_GREEN_HUES:        Deprecated alias for @GIMP_HUE_RANGE_GREEN
+ * @GIMP_CYAN_HUES:         Deprecated alias for @GIMP_HUE_RANGE_CYAN
+ * @GIMP_BLUE_HUES:         Deprecated alias for @GIMP_HUE_RANGE_BLUE
+ * @GIMP_MAGENTA_HUES:      Deprecated alias for @GIMP_HUE_RANGE_MAGENTA
  *
  * Hue ranges.
  **/
@@ -687,6 +730,9 @@ typedef enum
  * @GIMP_ICON_TYPE_ICON_NAME:     Icon name
  * @GIMP_ICON_TYPE_INLINE_PIXBUF: Inline pixbuf
  * @GIMP_ICON_TYPE_IMAGE_FILE:    Image file
+ * @GIMP_ICON_TYPE_STOCK_ID:      Deprecated alias for
+ *                                @GIMP_ICON_TYPE_ICON_NAME, old stock IDs
+ *                                are interpreted as icon names
  *
  * Icon types for plug-ins to register.
  **/
@@ -774,11 +820,12 @@ typedef enum
 
 /**
  * GimpInterpolationType:
- * @GIMP_INTERPOLATION_NONE:   None
- * @GIMP_INTERPOLATION_LINEAR: Linear
- * @GIMP_INTERPOLATION_CUBIC:  Cubic
- * @GIMP_INTERPOLATION_NOHALO: NoHalo
- * @GIMP_INTERPOLATION_LOHALO: LoHalo
+ * @GIMP_INTERPOLATION_NONE:    None
+ * @GIMP_INTERPOLATION_LINEAR:  Linear
+ * @GIMP_INTERPOLATION_CUBIC:   Cubic
+ * @GIMP_INTERPOLATION_NOHALO:  NoHalo
+ * @GIMP_INTERPOLATION_LOHALO:  LoHalo
+ * @GIMP_INTERPOLATION_LANCZOS: Deprecated alias for @GIMP_INTERPOLATION_NOHALO
  *
  * Interpolation types.
  **/
@@ -838,6 +885,15 @@ typedef enum
 } GimpMaskApplyMode;
 
 
+/**
+ * GimpMergeType:
+ * @GIMP_EXPAND_AS_NECESSARY:  Expanded as necessary
+ * @GIMP_CLIP_TO_IMAGE:        Clipped to image
+ * @GIMP_CLIP_TO_BOTTOM_LAYER: Clipped to bottom layer
+ * @GIMP_FLATTEN_IMAGE:        Flatten
+ *
+ * Types of merging layers.
+ **/
 #define GIMP_TYPE_MERGE_TYPE (gimp_merge_type_get_type ())
 
 GType gimp_merge_type_get_type (void) G_GNUC_CONST;
@@ -851,6 +907,14 @@ typedef enum
 } GimpMergeType;
 
 
+/**
+ * GimpMessageHandlerType:
+ * @GIMP_MESSAGE_BOX:   A popup dialog
+ * @GIMP_CONSOLE:       The terminal
+ * @GIMP_ERROR_CONSOLE: The error console dockable
+ *
+ * How to present messages.
+ **/
 #define GIMP_TYPE_MESSAGE_HANDLER_TYPE (gimp_message_handler_type_get_type ())
 
 GType gimp_message_handler_type_get_type (void) G_GNUC_CONST;
@@ -863,6 +927,13 @@ typedef enum
 } GimpMessageHandlerType;
 
 
+/**
+ * GimpOffsetType:
+ * @GIMP_OFFSET_BACKGROUND:  Background
+ * @GIMP_OFFSET_TRANSPARENT: Transparent
+ *
+ * Background fill types for the offset operation.
+ **/
 #define GIMP_TYPE_OFFSET_TYPE (gimp_offset_type_get_type ())
 
 GType gimp_offset_type_get_type (void) G_GNUC_CONST;
@@ -874,6 +945,14 @@ typedef enum
 } GimpOffsetType;
 
 
+/**
+ * GimpOrientationType:
+ * @GIMP_ORIENTATION_HORIZONTAL: Horizontal
+ * @GIMP_ORIENTATION_VERTICAL:   Vertical
+ * @GIMP_ORIENTATION_UNKNOWN:    Unknown
+ *
+ * Orientations for verious purposes.
+ **/
 #define GIMP_TYPE_ORIENTATION_TYPE (gimp_orientation_type_get_type ())
 
 GType gimp_orientation_type_get_type (void) G_GNUC_CONST;
@@ -886,6 +965,13 @@ typedef enum
 } GimpOrientationType;
 
 
+/**
+ * GimpPaintApplicationMode:
+ * @GIMP_PAINT_CONSTANT:    Constant
+ * @GIMP_PAINT_INCREMENTAL: Incremental
+ *
+ * Paint application modes.
+ **/
 #define GIMP_TYPE_PAINT_APPLICATION_MODE (gimp_paint_application_mode_get_type ())
 
 GType gimp_paint_application_mode_get_type (void) G_GNUC_CONST;
@@ -897,6 +983,37 @@ typedef enum
 } GimpPaintApplicationMode;
 
 
+/**
+ * GimpPDBArgType:
+ * @GIMP_PDB_INT32:       32-bit integer
+ * @GIMP_PDB_INT16:       16-bit integer
+ * @GIMP_PDB_INT8:        8-bit integer
+ * @GIMP_PDB_FLOAT:       Float
+ * @GIMP_PDB_STRING:      String
+ * @GIMP_PDB_INT32ARRAY:  Array of INT32
+ * @GIMP_PDB_INT16ARRAY:  Array of INT16
+ * @GIMP_PDB_INT8ARRAY:   Array of INT8
+ * @GIMP_PDB_FLOATARRAY:  Array of floats
+ * @GIMP_PDB_STRINGARRAY: Array of strings
+ * @GIMP_PDB_COLOR:       Color
+ * @GIMP_PDB_ITEM:        Item ID
+ * @GIMP_PDB_DISPLAY:     Display ID
+ * @GIMP_PDB_IMAGE:       Image ID
+ * @GIMP_PDB_LAYER:       Layer ID
+ * @GIMP_PDB_CHANNEL:     Channel ID
+ * @GIMP_PDB_DRAWABLE:    Drawable ID
+ * @GIMP_PDB_SELECTION:   Selection ID
+ * @GIMP_PDB_COLORARRAY:  Array of colors
+ * @GIMP_PDB_VECTORS:     Vectors (psath) ID
+ * @GIMP_PDB_PARASITE:    Parasite
+ * @GIMP_PDB_STATUS:      Procedure return status
+ * @GIMP_PDB_END:         Marker for last enum value
+ * @GIMP_PDB_PATH:        Deprecated alias for @GIMP_PDB_VECTORS
+ * @GIMP_PDB_BOUNDARY:    Deprecated alias for @GIMP_PDB_COLORARRAY
+ * @GIMP_PDB_REGION:      Deprecated alias for @GIMP_PDB_ITEM
+ *
+ * Parameter types of the PDB.
+ **/
 #define GIMP_TYPE_PDB_ARG_TYPE (gimp_pdb_arg_type_get_type ())
 
 GType gimp_pdb_arg_type_get_type (void) G_GNUC_CONST;
@@ -935,6 +1052,13 @@ typedef enum
 } GimpPDBArgType;
 
 
+/**
+ * GimpPDBErrorHandler:
+ * @GIMP_PDB_ERROR_HANDLER_INTERNAL: Internal
+ * @GIMP_PDB_ERROR_HANDLER_PLUGIN:   Plug-In
+ *
+ * PDB error handlers.
+ **/
 #define GIMP_TYPE_PDB_ERROR_HANDLER (gimp_pdb_error_handler_get_type ())
 
 GType gimp_pdb_error_handler_get_type (void) G_GNUC_CONST;
@@ -946,6 +1070,15 @@ typedef enum
 } GimpPDBErrorHandler;
 
 
+/**
+ * GimpPDBProcType:
+ * @GIMP_INTERNAL:  Internal GIMP procedure
+ * @GIMP_PLUGIN:    GIMP Plug-In
+ * @GIMP_EXTENSION: GIMP Extension
+ * @GIMP_TEMPORARY: Temporary Procedure
+ *
+ * Types of PDB procedures.
+ **/
 #define GIMP_TYPE_PDB_PROC_TYPE (gimp_pdb_proc_type_get_type ())
 
 GType gimp_pdb_proc_type_get_type (void) G_GNUC_CONST;
@@ -959,6 +1092,16 @@ typedef enum
 } GimpPDBProcType;
 
 
+/**
+ * GimpPDBStatusType:
+ * @GIMP_PDB_EXECUTION_ERROR: Execution error
+ * @GIMP_PDB_CALLING_ERROR:   Calling error
+ * @GIMP_PDB_PASS_THROUGH:    Pass through
+ * @GIMP_PDB_SUCCESS:         Success
+ * @GIMP_PDB_CANCEL:          User cancel
+ *
+ * Return status of PDB calls.
+ **/
 #define GIMP_TYPE_PDB_STATUS_TYPE (gimp_pdb_status_type_get_type ())
 
 GType gimp_pdb_status_type_get_type (void) G_GNUC_CONST;
@@ -973,6 +1116,25 @@ typedef enum
 } GimpPDBStatusType;
 
 
+/**
+ * GimpPrecision:
+ * @GIMP_PRECISION_U8_LINEAR:     8-bit linear integer
+ * @GIMP_PRECISION_U8_GAMMA:      8-bit gamma integer
+ * @GIMP_PRECISION_U16_LINEAR:    16-bit linear integer
+ * @GIMP_PRECISION_U16_GAMMA:     16-bit gamma integer
+ * @GIMP_PRECISION_U32_LINEAR:    32-bit linear integer
+ * @GIMP_PRECISION_U32_GAMMA:     32-bit gamma integer
+ * @GIMP_PRECISION_HALF_LINEAR:   16-bit linear floating point
+ * @GIMP_PRECISION_HALF_GAMMA:    16-bit gamma floating point
+ * @GIMP_PRECISION_FLOAT_LINEAR:  32-bit linear floating point
+ * @GIMP_PRECISION_FLOAT_GAMMA:   32-bit gamma floating point
+ * @GIMP_PRECISION_DOUBLE_LINEAR: 64-bit linear floating point
+ * @GIMP_PRECISION_DOUBLE_GAMMA:  64-bit gamma floating point
+ *
+ * Precisions for pixel encoding.
+ *
+ * Since: 2.10
+ **/
 #define GIMP_TYPE_PRECISION (gimp_precision_get_type ())
 
 GType gimp_precision_get_type (void) G_GNUC_CONST;
@@ -994,6 +1156,17 @@ typedef enum
 } GimpPrecision;
 
 
+/**
+ * GimpProgressCommand:
+ * @GIMP_PROGRESS_COMMAND_START:      Start a progress
+ * @GIMP_PROGRESS_COMMAND_END:        End the progress
+ * @GIMP_PROGRESS_COMMAND_SET_TEXT:   Set the text
+ * @GIMP_PROGRESS_COMMAND_SET_VALUE:  Set the percentage
+ * @GIMP_PROGRESS_COMMAND_PULSE:      Pulse the progress
+ * @GIMP_PROGRESS_COMMAND_GET_WINDOW: Get the window where the progress is shown
+ *
+ * Commands for the progress API.
+ **/
 #define GIMP_TYPE_PROGRESS_COMMAND (gimp_progress_command_get_type ())
 
 GType gimp_progress_command_get_type (void) G_GNUC_CONST;
@@ -1009,6 +1182,15 @@ typedef enum
 } GimpProgressCommand;
 
 
+/**
+ * GimpRepeatMode:
+ * @GIMP_REPEAT_NONE:       None (extend)
+ * @GIMP_REPEAT_SAWTOOTH:   Sawtooth wave
+ * @GIMP_REPEAT_TRIANGULAR: Triangular wave
+ * @GIMP_REPEAT_TRUNCATE:   Truncate
+ *
+ * Repeat modes for example for gradients.
+ **/
 #define GIMP_TYPE_REPEAT_MODE (gimp_repeat_mode_get_type ())
 
 GType gimp_repeat_mode_get_type (void) G_GNUC_CONST;
@@ -1022,6 +1204,14 @@ typedef enum
 } GimpRepeatMode;
 
 
+/**
+ * GimpRotationType:
+ * @GIMP_ROTATE_90:  90 degrees
+ * @GIMP_ROTATE_180: 180 degrees
+ * @GIMP_ROTATE_270: 270 degrees
+ *
+ * Types of simple rotations.
+ **/
 #define GIMP_TYPE_ROTATION_TYPE (gimp_rotation_type_get_type ())
 
 GType gimp_rotation_type_get_type (void) G_GNUC_CONST;
@@ -1034,6 +1224,14 @@ typedef enum
 } GimpRotationType;
 
 
+/**
+ * GimpRunMode:
+ * @GIMP_RUN_INTERACTIVE:    Run interactively
+ * @GIMP_RUN_NONINTERACTIVE: Run non-interactively
+ * @GIMP_RUN_WITH_LAST_VALS: Run with last used values
+ *
+ * Run modes for plug-ins.
+ **/
 #define GIMP_TYPE_RUN_MODE (gimp_run_mode_get_type ())
 
 GType gimp_run_mode_get_type (void) G_GNUC_CONST;
@@ -1046,6 +1244,22 @@ typedef enum
 } GimpRunMode;
 
 
+/**
+ * GimpSelectCriterion:
+ * @GIMP_SELECT_CRITERION_COMPOSITE: Composite
+ * @GIMP_SELECT_CRITERION_R:         Red
+ * @GIMP_SELECT_CRITERION_G:         Green
+ * @GIMP_SELECT_CRITERION_B:         Blue
+ * @GIMP_SELECT_CRITERION_H:         Hue (HSV)
+ * @GIMP_SELECT_CRITERION_S:         Saturation (HSV)
+ * @GIMP_SELECT_CRITERION_V:         Value (HSV)
+ * @GIMP_SELECT_CRITERION_A:         Alpha
+ * @GIMP_SELECT_CRITERION_LCH_L:     Lightness (LCH)
+ * @GIMP_SELECT_CRITERION_LCH_C:     Chroma (LCH)
+ * @GIMP_SELECT_CRITERION_LCH_H:     Hue (LCH)
+ *
+ * Criterions for color similarity.
+ **/
 #define GIMP_TYPE_SELECT_CRITERION (gimp_select_criterion_get_type ())
 
 GType gimp_select_criterion_get_type (void) G_GNUC_CONST;
@@ -1066,6 +1280,13 @@ typedef enum
 } GimpSelectCriterion;
 
 
+/**
+ * GimpSizeType:
+ * @GIMP_PIXELS: Pixels
+ * @GIMP_POINTS: Points
+ *
+ * Size types for the old-style text API.
+ **/
 #define GIMP_TYPE_SIZE_TYPE (gimp_size_type_get_type ())
 
 GType gimp_size_type_get_type (void) G_GNUC_CONST;
@@ -1077,6 +1298,14 @@ typedef enum
 } GimpSizeType;
 
 
+/**
+ * GimpStackTraceMode:
+ * @GIMP_STACK_TRACE_NEVER:  Never
+ * @GIMP_STACK_TRACE_QUERY:  Ask each time
+ * @GIMP_STACK_TRACE_ALWAYS: Always
+ *
+ * When to generate stack traces in case of an error.
+ **/
 #define GIMP_TYPE_STACK_TRACE_MODE (gimp_stack_trace_mode_get_type ())
 
 GType gimp_stack_trace_mode_get_type (void) G_GNUC_CONST;
@@ -1089,6 +1318,13 @@ typedef enum
 } GimpStackTraceMode;
 
 
+/**
+ * GimpStrokeMethod:
+ * @GIMP_STROKE_LINE:         Stroke line
+ * @GIMP_STROKE_PAINT_METHOD: Stroke with a paint tool
+ *
+ * Methods of stroking selections and paths.
+ **/
 #define GIMP_TYPE_STROKE_METHOD (gimp_stroke_method_get_type ())
 
 GType gimp_stroke_method_get_type (void) G_GNUC_CONST;
@@ -1100,6 +1336,13 @@ typedef enum
 } GimpStrokeMethod;
 
 
+/**
+ * GimpTextDirection:
+ * @GIMP_TEXT_DIRECTION_LTR: From left to right
+ * @GIMP_TEXT_DIRECTION_RTL: From right to left
+ *
+ * Text directions.
+ **/
 #define GIMP_TYPE_TEXT_DIRECTION (gimp_text_direction_get_type ())
 
 GType gimp_text_direction_get_type (void) G_GNUC_CONST;
@@ -1111,6 +1354,15 @@ typedef enum
 } GimpTextDirection;
 
 
+/**
+ * GimpTextHintStyle:
+ * @GIMP_TEXT_HINT_STYLE_NONE:   None
+ * @GIMP_TEXT_HINT_STYLE_SLIGHT: Slight
+ * @GIMP_TEXT_HINT_STYLE_MEDIUM: Medium
+ * @GIMP_TEXT_HINT_STYLE_FULL:   Full
+ *
+ * Text hint strengths.
+ **/
 #define GIMP_TYPE_TEXT_HINT_STYLE (gimp_text_hint_style_get_type ())
 
 GType gimp_text_hint_style_get_type (void) G_GNUC_CONST;
@@ -1124,6 +1376,15 @@ typedef enum
 } GimpTextHintStyle;
 
 
+/**
+ * GimpTextJustification:
+ * @GIMP_TEXT_JUSTIFY_LEFT:   Left justified
+ * @GIMP_TEXT_JUSTIFY_RIGHT:  Right justified
+ * @GIMP_TEXT_JUSTIFY_CENTER: Centered
+ * @GIMP_TEXT_JUSTIFY_FILL:   Filled
+ *
+ * Text justifications.
+ **/
 #define GIMP_TYPE_TEXT_JUSTIFICATION (gimp_text_justification_get_type ())
 
 GType gimp_text_justification_get_type (void) G_GNUC_CONST;
@@ -1137,6 +1398,17 @@ typedef enum
 } GimpTextJustification;
 
 
+/**
+ * GimpTransferMode:
+ * @GIMP_TRANSFER_SHADOWS:    Shadows
+ * @GIMP_TRANSFER_MIDTONES:   Midtones
+ * @GIMP_TRANSFER_HIGHLIGHTS: Highlights
+ * @GIMP_SHADOWS:             Deprecated alias for @GIMP_TRANSFER_SHADOWS
+ * @GIMP_MIDTONES:            Deprecated alias for @GIMP_TRANSFER_MIDTONES
+ * @GIMP_HIGHLIGHTS:          Deprecated alias for @GIMP_TRANSFER_HIGHLIGHTS
+ *
+ * For choosing which brightness ranges to transform.
+ **/
 #define GIMP_TYPE_TRANSFER_MODE (gimp_transfer_mode_get_type ())
 
 GType gimp_transfer_mode_get_type (void) G_GNUC_CONST;
@@ -1155,6 +1427,13 @@ typedef enum
 } GimpTransferMode;
 
 
+/**
+ * GimpTransformDirection:
+ * @GIMP_TRANSFORM_FORWARD:  Normal (Forward)
+ * @GIMP_TRANSFORM_BACKWARD: Corrective (Backward)
+ *
+ * Transform directions.
+ **/
 #define GIMP_TYPE_TRANSFORM_DIRECTION (gimp_transform_direction_get_type ())
 
 GType gimp_transform_direction_get_type (void) G_GNUC_CONST;
@@ -1166,6 +1445,15 @@ typedef enum
 } GimpTransformDirection;
 
 
+/**
+ * GimpTransformResize:
+ * @GIMP_TRANSFORM_RESIZE_ADJUST:           Adjust
+ * @GIMP_TRANSFORM_RESIZE_CLIP:             Clip
+ * @GIMP_TRANSFORM_RESIZE_CROP:             Crop to result
+ * @GIMP_TRANSFORM_RESIZE_CROP_WITH_ASPECT: Crop with aspect
+ *
+ * Ways of clipping the result when transforming drawables.
+ **/
 #define GIMP_TYPE_TRANSFORM_RESIZE (gimp_transform_resize_get_type ())
 
 GType gimp_transform_resize_get_type (void) G_GNUC_CONST;
@@ -1179,6 +1467,18 @@ typedef enum
 } GimpTransformResize;
 
 
+/**
+ * GimpUnit:
+ * @GIMP_UNIT_PIXEL:   Pixels
+ * @GIMP_UNIT_INCH:    Inches
+ * @GIMP_UNIT_MM:      Millimeters
+ * @GIMP_UNIT_POINT:   Points
+ * @GIMP_UNIT_PICA:    Picas
+ * @GIMP_UNIT_END:     Marker for end-of-builtin-units
+ * @GIMP_UNIT_PERCENT: Pseudo-unit percent
+ *
+ * Units used for dimensions in images.
+ **/
 typedef enum /*< skip >*/
 {
   GIMP_UNIT_PIXEL   = 0,
@@ -1195,6 +1495,19 @@ typedef enum /*< skip >*/
 
 
 #ifndef GIMP_DISABLE_DEPRECATED
+/**
+ * GimpUserDirectory:
+ * @GIMP_USER_DIRECTORY_DESKTOP:      Deprecated
+ * @GIMP_USER_DIRECTORY_DOCUMENTS:    Deprecated
+ * @GIMP_USER_DIRECTORY_DOWNLOAD:     Deprecated
+ * @GIMP_USER_DIRECTORY_MUSIC:        Deprecated
+ * @GIMP_USER_DIRECTORY_PICTURES:     Deprecated
+ * @GIMP_USER_DIRECTORY_PUBLIC_SHARE: Deprecated
+ * @GIMP_USER_DIRECTORY_TEMPLATES:    Deprecated
+ * @GIMP_USER_DIRECTORY_VIDEOS:       Deprecated
+ *
+ * Deprecated enum, don't use.
+ **/
 #define GIMP_TYPE_USER_DIRECTORY (gimp_user_directory_get_type ())
 
 GType gimp_user_directory_get_type (void) G_GNUC_CONST;
@@ -1213,6 +1526,12 @@ typedef enum
 #endif /* !GIMP_DISABLE_DEPRECATED */
 
 
+/**
+ * GimpVectorsStrokeType:
+ * @GIMP_VECTORS_STROKE_TYPE_BEZIER: A bezier stroke
+ *
+ * Possible type of strokes in vectors objects.
+ **/
 #define GIMP_TYPE_VECTORS_STROKE_TYPE (gimp_vectors_stroke_type_get_type ())
 
 GType gimp_vectors_stroke_type_get_type (void) G_GNUC_CONST;
diff --git a/libgimpbase/gimpcpuaccel.h b/libgimpbase/gimpcpuaccel.h
index 2ac43c8..689eb9d 100644
--- a/libgimpbase/gimpcpuaccel.h
+++ b/libgimpbase/gimpcpuaccel.h
@@ -26,6 +26,23 @@
 G_BEGIN_DECLS
 
 
+/**
+ * GimpCpuAccelFlags:
+ * @GIMP_CPU_ACCEL_NONE:        None
+ * @GIMP_CPU_ACCEL_X86_MMX:     MMX
+ * @GIMP_CPU_ACCEL_X86_3DNOW:   3dNow
+ * @GIMP_CPU_ACCEL_X86_MMXEXT:  MMXEXT
+ * @GIMP_CPU_ACCEL_X86_SSE:     SSE
+ * @GIMP_CPU_ACCEL_X86_SSE2:    SSE2
+ * @GIMP_CPU_ACCEL_X86_SSE3:    SSE3
+ * @GIMP_CPU_ACCEL_X86_SSSE3:   SSSE3
+ * @GIMP_CPU_ACCEL_X86_SSE4_1:  SSE4_1
+ * @GIMP_CPU_ACCEL_X86_SSE4_2:  SSE4_2
+ * @GIMP_CPU_ACCEL_X86_AVX:     AVX
+ * @GIMP_CPU_ACCEL_PPC_ALTIVEC: Altivec
+ *
+ * Types of detectable CPU accelerations
+ **/
 typedef enum
 {
   GIMP_CPU_ACCEL_NONE        = 0x0,
diff --git a/libgimpbase/gimpmetadata.h b/libgimpbase/gimpmetadata.h
index 8ef5e94..6d9ff49 100644
--- a/libgimpbase/gimpmetadata.h
+++ b/libgimpbase/gimpmetadata.h
@@ -31,6 +31,17 @@ G_BEGIN_DECLS
 #define GIMP_IS_METADATA_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_METADATA))
 #define GIMP_METADATA_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_METADATA, 
GimpMetadataClass))
 
+
+/**
+ * GimpMetadataLoadFlags:
+ * @GIMP_METADATA_LOAD_COMMENT:     Load the comment
+ * @GIMP_METADATA_LOAD_RESOLUTION:  Load the resolution
+ * @GIMP_METADATA_LOAD_ORIENTATION: Load the orientation (rotation)
+ * @GIMP_METADATA_LOAD_COLORSPACE:  Load the colorspace
+ * @GIMP_METADATA_LOAD_ALL:         Load all of the above
+ *
+ * What metadata to load when importing images.
+ **/
 typedef enum
 {
   GIMP_METADATA_LOAD_COMMENT     = 1 << 0,
@@ -41,6 +52,17 @@ typedef enum
   GIMP_METADATA_LOAD_ALL         = 0xffffffff
 } GimpMetadataLoadFlags;
 
+
+/**
+ * GimpMetadataSaveFlags:
+ * @GIMP_METADATA_SAVE_EXIF:      Save EXIF
+ * @GIMP_METADATA_SAVE_XMP:       Save XMP
+ * @GIMP_METADATA_SAVE_IPTC:      Save IPTC
+ * @GIMP_METADATA_SAVE_THUMBNAIL: Save a thumbnail of the image
+ * @GIMP_METADATA_SAVE_ALL:       Save all of the above
+ *
+ * What kinds of metadata to save when exporting images.
+ **/
 typedef enum
 {
   GIMP_METADATA_SAVE_EXIF      = 1 << 0,
@@ -51,6 +73,16 @@ typedef enum
   GIMP_METADATA_SAVE_ALL       = 0xffffffff
 } GimpMetadataSaveFlags;
 
+
+/**
+ * GimpMetadataColorspace:
+ * @GIMP_METADATA_COLORSPACE_UNSPECIFIED:  Unspecified
+ * @GIMP_METADATA_COLORSPACE_UNCALIBRATED: Uncalibrated
+ * @GIMP_METADATA_COLORSPACE_SRGB:         sRGB
+ * @GIMP_METADATA_COLORSPACE_ADOBERGB:     Adobe RGB
+ *
+ * Well-defined colorspace information available from metadata
+ **/
 typedef enum
 {
   GIMP_METADATA_COLORSPACE_UNSPECIFIED,
@@ -59,6 +91,7 @@ typedef enum
   GIMP_METADATA_COLORSPACE_ADOBERGB
 } GimpMetadataColorspace;
 
+
 GType          gimp_metadata_get_type            (void) G_GNUC_CONST;
 
 GimpMetadata * gimp_metadata_new                 (void);
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]