pdb, libgimp: generate some useless API docs for enums extracted from app/

To be improved...

libgimp/gimpenums.h

@@ -28,6 +28,13 @@ G_BEGIN_DECLS
 
 GType gimp_brush_application_mode_get_type (void) G_GNUC_CONST;
 
+/**
+ * GimpBrushApplicationMode:
+ * @GIMP_BRUSH_HARD: GIMP_BRUSH_HARD
+ * @GIMP_BRUSH_SOFT: GIMP_BRUSH_SOFT
+ *
+ * Extracted from app/paint/paint-enums.h
+ **/
 typedef enum
 {
   GIMP_BRUSH_HARD,
@@ -39,6 +46,15 @@ typedef enum
 
 GType gimp_convert_dither_type_get_type (void) G_GNUC_CONST;
 
+/**
+ * GimpConvertDitherType:
+ * @GIMP_CONVERT_DITHER_NONE: GIMP_CONVERT_DITHER_NONE
+ * @GIMP_CONVERT_DITHER_FS: GIMP_CONVERT_DITHER_FS
+ * @GIMP_CONVERT_DITHER_FS_LOWBLEED: GIMP_CONVERT_DITHER_FS_LOWBLEED
+ * @GIMP_CONVERT_DITHER_FIXED: GIMP_CONVERT_DITHER_FIXED
+ *
+ * Extracted from app/core/core-enums.h
+ **/
 typedef enum
 {
   GIMP_CONVERT_DITHER_NONE,
@@ -52,6 +68,17 @@ typedef enum
 
 GType gimp_histogram_channel_get_type (void) G_GNUC_CONST;
 
+/**
+ * GimpHistogramChannel:
+ * @GIMP_HISTOGRAM_VALUE: GIMP_HISTOGRAM_VALUE
+ * @GIMP_HISTOGRAM_RED: GIMP_HISTOGRAM_RED
+ * @GIMP_HISTOGRAM_GREEN: GIMP_HISTOGRAM_GREEN
+ * @GIMP_HISTOGRAM_BLUE: GIMP_HISTOGRAM_BLUE
+ * @GIMP_HISTOGRAM_ALPHA: GIMP_HISTOGRAM_ALPHA
+ * @GIMP_HISTOGRAM_LUMINANCE: GIMP_HISTOGRAM_LUMINANCE
+ *
+ * Extracted from app/core/core-enums.h
+ **/
 typedef enum
 {
   GIMP_HISTOGRAM_VALUE,
@@ -67,6 +94,14 @@ typedef enum
 
 GType gimp_layer_color_space_get_type (void) G_GNUC_CONST;
 
+/**
+ * GimpLayerColorSpace:
+ * @GIMP_LAYER_COLOR_SPACE_AUTO: GIMP_LAYER_COLOR_SPACE_AUTO
+ * @GIMP_LAYER_COLOR_SPACE_RGB_LINEAR: GIMP_LAYER_COLOR_SPACE_RGB_LINEAR
+ * @GIMP_LAYER_COLOR_SPACE_RGB_PERCEPTUAL: GIMP_LAYER_COLOR_SPACE_RGB_PERCEPTUAL
+ *
+ * Extracted from app/operations/operations-enums.h
+ **/
 typedef enum
 {
   GIMP_LAYER_COLOR_SPACE_AUTO,
@@ -79,6 +114,16 @@ typedef enum
 
 GType gimp_layer_composite_mode_get_type (void) G_GNUC_CONST;
 
+/**
+ * GimpLayerCompositeMode:
+ * @GIMP_LAYER_COMPOSITE_AUTO: GIMP_LAYER_COMPOSITE_AUTO
+ * @GIMP_LAYER_COMPOSITE_UNION: GIMP_LAYER_COMPOSITE_UNION
+ * @GIMP_LAYER_COMPOSITE_CLIP_TO_BACKDROP: GIMP_LAYER_COMPOSITE_CLIP_TO_BACKDROP
+ * @GIMP_LAYER_COMPOSITE_CLIP_TO_LAYER: GIMP_LAYER_COMPOSITE_CLIP_TO_LAYER
+ * @GIMP_LAYER_COMPOSITE_INTERSECTION: GIMP_LAYER_COMPOSITE_INTERSECTION
+ *
+ * Extracted from app/operations/operations-enums.h
+ **/
 typedef enum
 {
   GIMP_LAYER_COMPOSITE_AUTO,
@@ -93,6 +138,73 @@ typedef enum
 
 GType gimp_layer_mode_get_type (void) G_GNUC_CONST;
 
+/**
+ * GimpLayerMode:
+ * @GIMP_LAYER_MODE_NORMAL_LEGACY: GIMP_LAYER_MODE_NORMAL_LEGACY
+ * @GIMP_LAYER_MODE_DISSOLVE: GIMP_LAYER_MODE_DISSOLVE
+ * @GIMP_LAYER_MODE_BEHIND_LEGACY: GIMP_LAYER_MODE_BEHIND_LEGACY
+ * @GIMP_LAYER_MODE_MULTIPLY_LEGACY: GIMP_LAYER_MODE_MULTIPLY_LEGACY
+ * @GIMP_LAYER_MODE_SCREEN_LEGACY: GIMP_LAYER_MODE_SCREEN_LEGACY
+ * @GIMP_LAYER_MODE_OVERLAY_LEGACY: GIMP_LAYER_MODE_OVERLAY_LEGACY
+ * @GIMP_LAYER_MODE_DIFFERENCE_LEGACY: GIMP_LAYER_MODE_DIFFERENCE_LEGACY
+ * @GIMP_LAYER_MODE_ADDITION_LEGACY: GIMP_LAYER_MODE_ADDITION_LEGACY
+ * @GIMP_LAYER_MODE_SUBTRACT_LEGACY: GIMP_LAYER_MODE_SUBTRACT_LEGACY
+ * @GIMP_LAYER_MODE_DARKEN_ONLY_LEGACY: GIMP_LAYER_MODE_DARKEN_ONLY_LEGACY
+ * @GIMP_LAYER_MODE_LIGHTEN_ONLY_LEGACY: GIMP_LAYER_MODE_LIGHTEN_ONLY_LEGACY
+ * @GIMP_LAYER_MODE_HSV_HUE_LEGACY: GIMP_LAYER_MODE_HSV_HUE_LEGACY
+ * @GIMP_LAYER_MODE_HSV_SATURATION_LEGACY: GIMP_LAYER_MODE_HSV_SATURATION_LEGACY
+ * @GIMP_LAYER_MODE_HSL_COLOR_LEGACY: GIMP_LAYER_MODE_HSL_COLOR_LEGACY
+ * @GIMP_LAYER_MODE_HSV_VALUE_LEGACY: GIMP_LAYER_MODE_HSV_VALUE_LEGACY
+ * @GIMP_LAYER_MODE_DIVIDE_LEGACY: GIMP_LAYER_MODE_DIVIDE_LEGACY
+ * @GIMP_LAYER_MODE_DODGE_LEGACY: GIMP_LAYER_MODE_DODGE_LEGACY
+ * @GIMP_LAYER_MODE_BURN_LEGACY: GIMP_LAYER_MODE_BURN_LEGACY
+ * @GIMP_LAYER_MODE_HARDLIGHT_LEGACY: GIMP_LAYER_MODE_HARDLIGHT_LEGACY
+ * @GIMP_LAYER_MODE_SOFTLIGHT_LEGACY: GIMP_LAYER_MODE_SOFTLIGHT_LEGACY
+ * @GIMP_LAYER_MODE_GRAIN_EXTRACT_LEGACY: GIMP_LAYER_MODE_GRAIN_EXTRACT_LEGACY
+ * @GIMP_LAYER_MODE_GRAIN_MERGE_LEGACY: GIMP_LAYER_MODE_GRAIN_MERGE_LEGACY
+ * @GIMP_LAYER_MODE_COLOR_ERASE_LEGACY: GIMP_LAYER_MODE_COLOR_ERASE_LEGACY
+ * @GIMP_LAYER_MODE_OVERLAY: GIMP_LAYER_MODE_OVERLAY
+ * @GIMP_LAYER_MODE_LCH_HUE: GIMP_LAYER_MODE_LCH_HUE
+ * @GIMP_LAYER_MODE_LCH_CHROMA: GIMP_LAYER_MODE_LCH_CHROMA
+ * @GIMP_LAYER_MODE_LCH_COLOR: GIMP_LAYER_MODE_LCH_COLOR
+ * @GIMP_LAYER_MODE_LCH_LIGHTNESS: GIMP_LAYER_MODE_LCH_LIGHTNESS
+ * @GIMP_LAYER_MODE_NORMAL: GIMP_LAYER_MODE_NORMAL
+ * @GIMP_LAYER_MODE_BEHIND: GIMP_LAYER_MODE_BEHIND
+ * @GIMP_LAYER_MODE_MULTIPLY: GIMP_LAYER_MODE_MULTIPLY
+ * @GIMP_LAYER_MODE_SCREEN: GIMP_LAYER_MODE_SCREEN
+ * @GIMP_LAYER_MODE_DIFFERENCE: GIMP_LAYER_MODE_DIFFERENCE
+ * @GIMP_LAYER_MODE_ADDITION: GIMP_LAYER_MODE_ADDITION
+ * @GIMP_LAYER_MODE_SUBTRACT: GIMP_LAYER_MODE_SUBTRACT
+ * @GIMP_LAYER_MODE_DARKEN_ONLY: GIMP_LAYER_MODE_DARKEN_ONLY
+ * @GIMP_LAYER_MODE_LIGHTEN_ONLY: GIMP_LAYER_MODE_LIGHTEN_ONLY
+ * @GIMP_LAYER_MODE_HSV_HUE: GIMP_LAYER_MODE_HSV_HUE
+ * @GIMP_LAYER_MODE_HSV_SATURATION: GIMP_LAYER_MODE_HSV_SATURATION
+ * @GIMP_LAYER_MODE_HSL_COLOR: GIMP_LAYER_MODE_HSL_COLOR
+ * @GIMP_LAYER_MODE_HSV_VALUE: GIMP_LAYER_MODE_HSV_VALUE
+ * @GIMP_LAYER_MODE_DIVIDE: GIMP_LAYER_MODE_DIVIDE
+ * @GIMP_LAYER_MODE_DODGE: GIMP_LAYER_MODE_DODGE
+ * @GIMP_LAYER_MODE_BURN: GIMP_LAYER_MODE_BURN
+ * @GIMP_LAYER_MODE_HARDLIGHT: GIMP_LAYER_MODE_HARDLIGHT
+ * @GIMP_LAYER_MODE_SOFTLIGHT: GIMP_LAYER_MODE_SOFTLIGHT
+ * @GIMP_LAYER_MODE_GRAIN_EXTRACT: GIMP_LAYER_MODE_GRAIN_EXTRACT
+ * @GIMP_LAYER_MODE_GRAIN_MERGE: GIMP_LAYER_MODE_GRAIN_MERGE
+ * @GIMP_LAYER_MODE_VIVID_LIGHT: GIMP_LAYER_MODE_VIVID_LIGHT
+ * @GIMP_LAYER_MODE_PIN_LIGHT: GIMP_LAYER_MODE_PIN_LIGHT
+ * @GIMP_LAYER_MODE_LINEAR_LIGHT: GIMP_LAYER_MODE_LINEAR_LIGHT
+ * @GIMP_LAYER_MODE_HARD_MIX: GIMP_LAYER_MODE_HARD_MIX
+ * @GIMP_LAYER_MODE_EXCLUSION: GIMP_LAYER_MODE_EXCLUSION
+ * @GIMP_LAYER_MODE_LINEAR_BURN: GIMP_LAYER_MODE_LINEAR_BURN
+ * @GIMP_LAYER_MODE_LUMA_DARKEN_ONLY: GIMP_LAYER_MODE_LUMA_DARKEN_ONLY
+ * @GIMP_LAYER_MODE_LUMA_LIGHTEN_ONLY: GIMP_LAYER_MODE_LUMA_LIGHTEN_ONLY
+ * @GIMP_LAYER_MODE_LUMINANCE: GIMP_LAYER_MODE_LUMINANCE
+ * @GIMP_LAYER_MODE_COLOR_ERASE: GIMP_LAYER_MODE_COLOR_ERASE
+ * @GIMP_LAYER_MODE_ERASE: GIMP_LAYER_MODE_ERASE
+ * @GIMP_LAYER_MODE_MERGE: GIMP_LAYER_MODE_MERGE
+ * @GIMP_LAYER_MODE_SPLIT: GIMP_LAYER_MODE_SPLIT
+ * @GIMP_LAYER_MODE_PASS_THROUGH: GIMP_LAYER_MODE_PASS_THROUGH
+ *
+ * Extracted from app/operations/operations-enums.h
+ **/
 typedef enum
 {
   GIMP_LAYER_MODE_NORMAL_LEGACY,

pdb/enumcode.pl

@@ -77,9 +77,23 @@ foreach (sort keys %enums) {
 
 	print ENUMFILE "\n#define GIMP_TYPE_$gtype (gimp_$func\_get_type ())\n\n";
 	print ENUMFILE "GType gimp_$func\_get_type (void) G_GNUC_CONST;\n\n";
+
+	print ENUMFILE "/**\n";
+	print ENUMFILE " * $_:\n";
+
+	my $enum = $enums{$_};
+
+	foreach $symbol (@{$enum->{symbols}}) {
+	    print ENUMFILE " * @" . $symbol . ": " . $symbol . "\n";
+	}
+
+	print ENUMFILE " *\n";
+	print ENUMFILE " * Extracted from app/" . $enums{$_}->{header} . "\n";
+	print ENUMFILE " **/\n";
+
 	print ENUMFILE "typedef enum\n{\n";
 
-	my $enum = $enums{$_}; my $body = "";
+	my $body = "";
 
 	foreach $symbol (@{$enum->{symbols}}) {
 	    my $sym = $symbol;