[gimp] libgimp: documented some enum values until i got bored



commit 2b7ebd97fbee5c570974aea023eb46afeebe519f
Author: Michael Natterer <mitch gimp org>
Date:   Mon Jul 12 23:27:14 2010 +0200

    libgimp: documented some enum values until i got bored

 libgimp/gimpenums.h |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)
---
diff --git a/libgimp/gimpenums.h b/libgimp/gimpenums.h
index d52c978..a5aef1a 100644
--- a/libgimp/gimpenums.h
+++ b/libgimp/gimpenums.h
@@ -35,6 +35,14 @@ typedef enum
 } GimpBrushApplicationMode;
 
 
+/**
+ * GimpBrushGeneratedShape:
+ * @GIMP_BRUSH_GENERATED_CIRCLE:  The brush has a circle shape.
+ * @GIMP_BRUSH_GENERATED_SQUARE:  The brush has a square shape.
+ * @GIMP_BRUSH_GENERATED_DIAMOND: The brush has a diamond shape.
+ *
+ * The possible shapes generated brushes can take.
+ **/
 #define GIMP_TYPE_BRUSH_GENERATED_SHAPE (gimp_brush_generated_shape_get_type ())
 
 GType gimp_brush_generated_shape_get_type (void) G_GNUC_CONST;
@@ -86,6 +94,13 @@ typedef enum
 } GimpConvolutionType;
 
 
+/**
+ * GimpConvolveMode:
+ * @GIMP_BLUR_CONVOLVE:    Blur the drawable.
+ * @GIMP_SHARPEN_CONVOLVE: Sharpen the drawable.
+ *
+ * Operation modes of the convolve tool.
+ **/
 #define GIMP_TYPE_CONVOLVE_TYPE (gimp_convolve_type_get_type ())
 
 GType gimp_convolve_type_get_type (void) G_GNUC_CONST;
@@ -234,6 +249,14 @@ typedef enum
 } GimpOffsetType;
 
 
+/**
+ * GimpOrientationType:
+ * @GIMP_ORIENTATION_HORIZONTAL: Horizontal ortientation.
+ * @GIMP_ORIENTATION_VERTICAL:   Vertical orientation.
+ * @GIMP_ORIENTATION_UNKNOWN:    Undetermined orientation.
+ *
+ * Orientation values for all kinds of purposes, like guides.
+ **/
 #define GIMP_TYPE_ORIENTATION_TYPE (gimp_orientation_type_get_type ())
 
 GType gimp_orientation_type_get_type (void) G_GNUC_CONST;
@@ -246,6 +269,14 @@ typedef enum
 } GimpOrientationType;
 
 
+/**
+ * GimpRotationType:
+ * @GIMP_ROTATE_90:   Rotate by 90 degrees.
+ * @GIMP_ROTATE_180:  Rotate by 180 degrees.
+ * @GIMP_ROTATE_270:  Rotate by 270 degrees.
+ *
+ * Steps for simple rotation based on multpiles of 90 degrees.
+ **/
 #define GIMP_TYPE_ROTATION_TYPE (gimp_rotation_type_get_type ())
 
 GType gimp_rotation_type_get_type (void) G_GNUC_CONST;



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]