Commit fd8ed809 authored by Øyvind Kolås's avatar Øyvind Kolås

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:

svn path=/trunk/; revision=2497
parent 243c7b47
2008-06-23 Øyvind Kolås <pippin@gimp.org>
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:
2008-06-23 Øyvind Kolås <pippin@gimp.org>
* gegl/property-types/gegl-color.c: (gegl_color_get_string): applied
......
......@@ -716,7 +716,7 @@ gegl_buffer_class_init (GeglBufferClass *class)
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,
......
......@@ -50,7 +50,7 @@ GType gegl_buffer_get_type (void) G_GNUC_CONST;
*
* 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 @@ GeglBuffer* gegl_buffer_new (const GeglRectangle *extent,
/**
* 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 @@ void gegl_buffer_save (GeglBuffer *buffer,
/**
* 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 @@ const GeglRectangle * gegl_buffer_get_extent (GeglBuffer *buffer);
*
* 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 @@ gboolean gegl_buffer_set_extent (GeglBuffer *buffer,
* 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 @@ gboolean gegl_buffer_set_extent (GeglBuffer *buffer,
* 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 @@ gboolean gegl_buffer_set_extent (GeglBuffer *buffer,
* 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 @@ gboolean gegl_buffer_set_extent (GeglBuffer *buffer,
* 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 @@ typedef enum {
* @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
......
......@@ -158,7 +158,7 @@ gegl_config_class_init (GeglConfigClass *klass)
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 @@ gegl_config_class_init (GeglConfigClass *klass)
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));
......
......@@ -150,7 +150,7 @@ gegl_node_class_init (GeglNodeClass *klass)
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));
......
......@@ -51,13 +51,13 @@ struct _GeglOperation
* 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.
*/
......
......@@ -94,7 +94,7 @@ gegl_processor_class_init (GeglProcessorClass *klass)
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 @@ gegl_processor_class_init (GeglProcessorClass *klass)
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));
......
......@@ -243,7 +243,7 @@ op_affine_class_init (OpAffineClass *klass)
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));
}
......
......@@ -23,7 +23,7 @@ gegl_chant_double (degrees, -G_MAXDOUBLE, G_MAXDOUBLE, 0., "Angle to rotate (clo
#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"
......
......@@ -188,7 +188,7 @@ gegl_chant_class_init (GeglChantClass *klass)
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
......@@ -90,7 +90,7 @@ gegl_chant_class_init (GeglChantClass *klass)
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
......@@ -118,7 +118,7 @@ gegl_chant_class_init (GeglChantClass *klass)
operation_class->name = "introspect";
operation_class->categories = "render";
operation_class->description = "GEGL graph vizualizer.";
operation_class->description = "GEGL graph visualizer.";
}
#endif
......
......@@ -27,9 +27,9 @@ gegl_chant_double(x, "X", -G_MAXDOUBLE, G_MAXDOUBLE, 0.0,
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")
......
......@@ -150,7 +150,7 @@ gegl_chant_class_init (GeglChantClass *klass)
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).";
}
......
......@@ -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")
......
......@@ -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
......
......@@ -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.")
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment