GNOME.org
 

gegl r2497 - in trunk: . gegl gegl/buffer gegl/graph gegl/operation gegl/process operations/affine operations/common operations/external operations/workshop

Author: ok
Date: Mon Jun 23 13:08:12 2008
New Revision: 2497
URL: http://svn.gnome.org/viewvc/gegl?rev=2497&view=rev

Log:
Documentation improvements (mostly orthographic) from Peter
(gib_mir_mehl at gmx.net).
* gegl/buffer/gegl-buffer.c:
* gegl/buffer/gegl-buffer.h:
* gegl/gegl-config.c:
* gegl/graph/gegl-node.c:
* gegl/operation/gegl-operation.h:
* gegl/process/gegl-processor.c:
* operations/affine/affine.c:
* operations/affine/rotate.c:
* operations/common/c2g.c:
* operations/common/difference-of-gaussians.c:
* operations/common/introspect.c:
* operations/common/rectangle.c:
* operations/common/stretch-contrast.c:
* operations/external/display.c:
* operations/external/save-pixbuf.c:
* operations/workshop/snn-percentile.c:


Modified:
   trunk/ChangeLog
   trunk/gegl/buffer/gegl-buffer.c
   trunk/gegl/buffer/gegl-buffer.h
   trunk/gegl/gegl-config.c
   trunk/gegl/graph/gegl-node.c
   trunk/gegl/operation/gegl-operation.h
   trunk/gegl/process/gegl-processor.c
   trunk/operations/affine/affine.c
   trunk/operations/affine/rotate.c
   trunk/operations/common/c2g.c
   trunk/operations/common/difference-of-gaussians.c
   trunk/operations/common/introspect.c
   trunk/operations/common/rectangle.c
   trunk/operations/common/stretch-contrast.c
   trunk/operations/external/display.c
   trunk/operations/external/save-pixbuf.c
   trunk/operations/workshop/snn-percentile.c

Modified: trunk/gegl/buffer/gegl-buffer.c
==============================================================================
--- trunk/gegl/buffer/gegl-buffer.c	(original)
+++ trunk/gegl/buffer/gegl-buffer.c	Mon Jun 23 13:08:12 2008
@@ -716,7 +716,7 @@
                                                      0, G_MAXINT, 0,
                                                      G_PARAM_READABLE));
   g_object_class_install_property (gobject_class, PROP_PIXELS,
-                                   g_param_spec_int ("pixels", "pixels", "total amount of pixels in image (widthÃheight)",
+                                   g_param_spec_int ("pixels", "pixels", "total amount of pixels in image (width x height)",
                                                      0, G_MAXINT, 0,
                                                      G_PARAM_READABLE));
   g_object_class_install_property (gobject_class, PROP_WIDTH,

Modified: trunk/gegl/buffer/gegl-buffer.h
==============================================================================
--- trunk/gegl/buffer/gegl-buffer.h	(original)
+++ trunk/gegl/buffer/gegl-buffer.h	Mon Jun 23 13:08:12 2008
@@ -50,7 +50,7 @@
  *
  * Create a new GeglBuffer of a given format with a given extent. It is
  * possible to pass in NULL for both extent and format, a NULL extent creates
- * an exmpty buffer and a NULL format makes the buffer default to "RGBA float".
+ * an empty buffer and a NULL format makes the buffer default to "RGBA float".
  */
 GeglBuffer*     gegl_buffer_new               (const GeglRectangle *extent,
                                                const Babl          *format);
@@ -59,7 +59,6 @@
 /**
  * gegl_buffer_open:
  * @path: the path to a gegl buffer on disk.
- * be opened.
  *
  * Open an existing on-disk GeglBuffer, this buffer is opened in a monitored
  * state so multiple instances of gegl can share the same buffer. Sets on
@@ -85,7 +84,6 @@
 /**
  * gegl_buffer_load:
  * @path: the path to a gegl buffer on disk.
- * be opened.
  *
  * Loads an existing GeglBuffer from disk, if it has previously been saved with
  * gegl_buffer_save it should be possible to open through any GIO transport, buffers
@@ -143,7 +141,7 @@
  *
  * Changes the size and position that is considered active in a buffer, this
  * operation is valid on any buffer, reads on subbuffers outside the master
- * buffers extent are at the moment undefined.
+ * buffer's extent are at the moment undefined.
  *
  * Returns TRUE if the change of extent was succesful.
  */
@@ -156,7 +154,7 @@
  * gegl_buffer_get_x:
  * @buffer: a GeglBuffer
  *
- * Evaluates to the X coordinate of the upper left corner of the buffers extent.
+ * Evaluates to the X coordinate of the upper left corner of the buffer's extent.
  */
 #define gegl_buffer_get_x(buffer)        (gegl_buffer_get_extent(buffer)->x)
 
@@ -164,7 +162,7 @@
  * gegl_buffer_get_y:
  * @buffer: a GeglBuffer
  *
- * Evaluates to the Y coordinate of the upper left corner of the buffers extent.
+ * Evaluates to the Y coordinate of the upper left corner of the buffer's extent.
  */
 #define gegl_buffer_get_y(buffer)        (gegl_buffer_get_extent(buffer)->y)
 
@@ -172,7 +170,7 @@
  * gegl_buffer_get_width:
  * @buffer: a GeglBuffer
  *
- * Evaluates to the width of the buffers extent.
+ * Evaluates to the width of the buffer's extent.
  */
 #define gegl_buffer_get_width(buffer)    (gegl_buffer_get_extent(buffer)->width)
 
@@ -180,7 +178,7 @@
  * gegl_buffer_get_height:
  * @buffer: a GeglBuffer
  *
- * Evaluates to the height of the buffers extent.
+ * Evaluates to the height of the buffer's extent.
  */
 #define gegl_buffer_get_height(buffer)   (gegl_buffer_get_extent(buffer)->height)
 
@@ -295,7 +293,7 @@
  * @buffer: the GeglBuffer to sample from
  * @x: x coordinate to sample in buffer coordinates
  * @y: y coordinate to sample in buffer coordinates
- * @scale: the scale we're fetching at (<1.0 can leads to decimation)
+ * @scale: the scale we're fetching at (<1.0 can lead to decimation)
  * @dest: buffer capable of storing one pixel in @format.
  * @format: the format to store the sampled color in.
  * @interpolation: the interpolation behavior to use, currently only nearest

Modified: trunk/gegl/gegl-config.c
==============================================================================
--- trunk/gegl/gegl-config.c	(original)
+++ trunk/gegl/gegl-config.c	Mon Jun 23 13:08:12 2008
@@ -158,7 +158,7 @@
                                                      G_PARAM_READWRITE));
 
   g_object_class_install_property (gobject_class, PROP_TILE_HEIGHT,
-                                   g_param_spec_int ("tile-height", "Tile height", "default tile heightfor created buffers.",
+                                   g_param_spec_int ("tile-height", "Tile height", "default tile height for created buffers.",
                                                      0, G_MAXINT, 64,
                                                      G_PARAM_READWRITE));
 
@@ -170,7 +170,7 @@
 
   g_object_class_install_property (gobject_class, PROP_CHUNK_SIZE,
                                    g_param_spec_int ("chunk-size", "Chunk size",
-                                     "the number of pixels processed simulatnously by GEGL.",
+                                     "the number of pixels processed simultaneously by GEGL.",
                                                      1, G_MAXINT, 256*300,
                                                      G_PARAM_READWRITE));
 

Modified: trunk/gegl/graph/gegl-node.c
==============================================================================
--- trunk/gegl/graph/gegl-node.c	(original)
+++ trunk/gegl/graph/gegl-node.c	Mon Jun 23 13:08:12 2008
@@ -150,7 +150,7 @@
   g_object_class_install_property (gobject_class, PROP_DONT_CACHE,
                                    g_param_spec_boolean ("dont-cache",
                                                          "Do not cache",
-                                                        "Do not cache the result of this operation, the property is inherithed by children created from a node.",
+                                                        "Do not cache the result of this operation, the property is inherited by children created from a node.",
                                                         TRUE,
                                                         G_PARAM_READWRITE));
 

Modified: trunk/gegl/operation/gegl-operation.h
==============================================================================
--- trunk/gegl/operation/gegl-operation.h	(original)
+++ trunk/gegl/operation/gegl-operation.h	Mon Jun 23 13:08:12 2008
@@ -51,13 +51,13 @@
  * GeglOperation:
  * 
  * All the image processing code in GEGL is implemented as GeglOperations,
- * GEGL oeprations are implemented as GObject with a convenience API called
+ * GEGL operations are implemented as GObject with a convenience API called
  * chanting that abstracts away the boiler plater needed to generate introspectable
  * named properties of different types.
  *
  * Most types of operations like: filters, composers, sources, sinks, point
  * operations, compositing operations, and spatial operations with fixed
- * neighbourhoods. These base classes builds on top of the GeglOperationsClass:
+ * neighbourhoods. These base classes build on top of the GeglOperationsClass:
  *
  * See <a href='gegl-plugin.h.html'>gegl-plugin.h</a> for details.
  */

Modified: trunk/gegl/process/gegl-processor.c
==============================================================================
--- trunk/gegl/process/gegl-processor.c	(original)
+++ trunk/gegl/process/gegl-processor.c	Mon Jun 23 13:08:12 2008
@@ -94,7 +94,7 @@
   g_object_class_install_property (gobject_class, PROP_NODE,
                                    g_param_spec_object ("node",
                                                         "GeglNode",
-                                                        "The GeglNode to process (will saturate the providers cache if it the provided node is a sink node)",
+                                                        "The GeglNode to process (will saturate the provider's cache if the provided node is a sink node)",
                                                         GEGL_TYPE_NODE,
                                                         G_PARAM_WRITABLE |
                                                         G_PARAM_CONSTRUCT));
@@ -108,7 +108,7 @@
   g_object_class_install_property (gobject_class, PROP_PROGRESS,
                                    g_param_spec_double ("progress",
                                                         "progress",
-                                                        "query progress 0.0 is not started 1.0 is done.",
+                                                        "query progress; 0.0 is not started, 1.0 is done.",
                                                         0.0, 1.0, 0.0,
                                                         G_PARAM_READWRITE));
 

Modified: trunk/operations/affine/affine.c
==============================================================================
--- trunk/operations/affine/affine.c	(original)
+++ trunk/operations/affine/affine.c	Mon Jun 23 13:08:12 2008
@@ -243,7 +243,7 @@
                                    g_param_spec_int (
                                      "lanczos-width",
                                      "Lanczos-width",
-                                     "Lanczos-width width of lanczos function",
+                                     "Width of lanczos function",
                                      3, 6, 3,
                                      G_PARAM_CONSTRUCT | G_PARAM_READWRITE));
 }

Modified: trunk/operations/affine/rotate.c
==============================================================================
--- trunk/operations/affine/rotate.c	(original)
+++ trunk/operations/affine/rotate.c	Mon Jun 23 13:08:12 2008
@@ -23,7 +23,7 @@
 #else
 
 #define GEGL_CHANT_NAME rotate
-#define GEGL_CHANT_DESCRIPTION  "Rotate the buffer around the specfied origin."
+#define GEGL_CHANT_DESCRIPTION  "Rotate the buffer around the specified origin."
 #define GEGL_CHANT_SELF "rotate.c"
 #include "chant.h"
 

Modified: trunk/operations/common/c2g.c
==============================================================================
--- trunk/operations/common/c2g.c	(original)
+++ trunk/operations/common/c2g.c	Mon Jun 23 13:08:12 2008
@@ -188,7 +188,7 @@
   operation_class->name        = "c2g";
   operation_class->categories  = "enhance";
   operation_class->description =
-        "Color to grayscale conversion that uses, spatial color differences to perform local grayscale contrast enhancement.";
+        "Color to grayscale conversion, uses spatial color differences to perform local grayscale contrast enhancement.";
 }
 
 #endif

Modified: trunk/operations/common/difference-of-gaussians.c
==============================================================================
--- trunk/operations/common/difference-of-gaussians.c	(original)
+++ trunk/operations/common/difference-of-gaussians.c	Mon Jun 23 13:08:12 2008
@@ -90,7 +90,7 @@
   operation_class->name        = "difference-of-gaussians";
   operation_class->categories  = "meta:edge";
   operation_class->description =
-        "Does an edge detection based on the differnece of two gaussian blurs.";
+        "Does an edge detection based on the difference of two gaussian blurs.";
 }
 
 #endif

Modified: trunk/operations/common/introspect.c
==============================================================================
--- trunk/operations/common/introspect.c	(original)
+++ trunk/operations/common/introspect.c	Mon Jun 23 13:08:12 2008
@@ -118,7 +118,7 @@
 
   operation_class->name        = "introspect";
   operation_class->categories  = "render";
-  operation_class->description = "GEGL graph vizualizer.";
+  operation_class->description = "GEGL graph visualizer.";
 }
 
 #endif

Modified: trunk/operations/common/rectangle.c
==============================================================================
--- trunk/operations/common/rectangle.c	(original)
+++ trunk/operations/common/rectangle.c	Mon Jun 23 13:08:12 2008
@@ -27,9 +27,9 @@
 gegl_chant_double(y, "Y", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0,
                   "Vertical position")
 gegl_chant_double(width, "Width", 0, G_MAXDOUBLE, 0.0,
-                  "Horizontal position")
+                  "Horizontal extent")
 gegl_chant_double(height, "Height", 0, G_MAXDOUBLE, 0.0,
-                  "Vertical position")
+                  "Vertical extent")
 gegl_chant_color(color, "Color", "white",
                   "Color to render")
 

Modified: trunk/operations/common/stretch-contrast.c
==============================================================================
--- trunk/operations/common/stretch-contrast.c	(original)
+++ trunk/operations/common/stretch-contrast.c	Mon Jun 23 13:08:12 2008
@@ -150,7 +150,7 @@
   operation_class->categories  = "color:enhance";
   operation_class->description =
         "Scales the components of the buffer to be in the 0.0-1.0 range."
-        " This improves images that makes poor use of the available contrast"
+        " This improves images that make poor use of the available contrast"
         " (little contrast, very dark, or very bright images).";
 }
 

Modified: trunk/operations/external/display.c
==============================================================================
--- trunk/operations/external/display.c	(original)
+++ trunk/operations/external/display.c	Mon Jun 23 13:08:12 2008
@@ -18,7 +18,7 @@
 #ifdef GEGL_CHANT_PROPERTIES
 
 gegl_chant_string  (window_title, "", "window_title",
-                    "Title to be given output window")
+                    "Title to be given to output window")
 gegl_chant_string  (icon_title, "", "icon_title",
                     "Icon to be used for output window")
 

Modified: trunk/operations/external/save-pixbuf.c
==============================================================================
--- trunk/operations/external/save-pixbuf.c	(original)
+++ trunk/operations/external/save-pixbuf.c	Mon Jun 23 13:08:12 2008
@@ -18,7 +18,7 @@
 #ifdef GEGL_CHANT_PROPERTIES
 
 gegl_chant_pointer (pixbuf, "Pixbuf location",
-                    "The location where to store the output GdkPixuf.")
+                    "The location where to store the output GdkPixbuf.")
 
 #else
 

Modified: trunk/operations/workshop/snn-percentile.c
==============================================================================
--- trunk/operations/workshop/snn-percentile.c	(original)
+++ trunk/operations/workshop/snn-percentile.c	Mon Jun 23 13:08:12 2008
@@ -22,7 +22,7 @@
 gegl_chant_double (radius, "Radius", 0.0, 70.0, 8.0,
   "Radius of square pixel region (width and height will be radius*2+1)")
 gegl_chant_int (pairs, "Pairs", 1, 2, 2,
-  "Number of pairs higher number preserves more acute features")
+  "Number of pairs, higher number preserves more acute features")
 gegl_chant_double (percentile, "Percentile", 0.0, 100.0, 50.0,
   "The percentile to return, the default value 50 is equal to the median.")
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]