From ab697a79a618de8e1fc457944e575620d50f98bb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20Grubbstr=C3=B6m=20=28Grubba=29?=
<grubba@grubba.org>
Date: Sat, 2 Aug 2014 10:40:38 +0200
Subject: [PATCH] Image: Fixed a few documentation typos.
---
lib/modules/_Image_PSD.pmod | 6 +-
lib/modules/_Image_XCF.pmod | 44 +++++++-------
lib/modules/_Image_XPM.pmod | 14 ++---
src/modules/Image/encodings/hrz.c | 2 +-
src/post_modules/_Image_WebP/image_webp.cmod | 61 ++++++++++----------
5 files changed, 64 insertions(+), 63 deletions(-)
diff --git a/lib/modules/_Image_PSD.pmod b/lib/modules/_Image_PSD.pmod
index 82192f1eeb..eb9c4d1891 100644
--- a/lib/modules/_Image_PSD.pmod
+++ b/lib/modules/_Image_PSD.pmod
@@ -441,11 +441,11 @@ string translate_mode( string mode )
//!
//! Accepts these options:
//! @mapping
-//! @member bool draw_all_layers
+//! @member bool "draw_all_layers"
//! If included, all layers will be decoded, even the non-visible ones.
-//! @member bool crop_to_bounds
+//! @member bool "crop_to_bounds"
//! Remove areas that are outside the image boundaries in all layers
-//! @member Image.Color background
+//! @member Image.Color "background"
//! If included, include a solid background layer with the given color
//! @endmapping
array decode_layers( string|mapping what, mapping|void opts )
diff --git a/lib/modules/_Image_XCF.pmod b/lib/modules/_Image_XCF.pmod
index e88be0a9c3..ebea8f1d4c 100644
--- a/lib/modules/_Image_XCF.pmod
+++ b/lib/modules/_Image_XCF.pmod
@@ -549,30 +549,30 @@ string translate_mode( int mode )
//!
//! The options can contain one or more of these options:
//! @mapping
-//! @member bool draw_all_layers
+//! @member bool "draw_all_layers"
//! If included, all layers will be decoded, even the non-visible ones.
-//! @member Image.Color background
+//! @member Image.Color "background"
//! If included, include a solid background layer with the given color
-//! @member int shrink_fact
+//! @member int "shrink_fact"
//! Shrink the image by a factor of X. Useful for previews.
//! @endmapping
//!
//! The layers have a number of extra properties set on them:
//!
//! @mapping
-//! @member int image_xres
-//! @member int image_yres
-//! @member Image.Colormap image_colormap
-//! @member array(Guide) image_guides
-//! @member array(Parasite) image_parasites
+//! @member int "image_xres"
+//! @member int "image_yres"
+//! @member Image.Colormap "image_colormap"
+//! @member array(Guide) "image_guides"
+//! @member array(Parasite) "image_parasites"
//! Values, global to all layers, copied from the GimpImage.
//! Still present in all layers
//!
-//! @member string name
-//! @member bool visible
-//! @member bool active
-//! @member int tatoo
-//! @member array(Parasite) parasites
+//! @member string "name"
+//! @member bool "visible"
+//! @member bool "active"
+//! @member int "tatoo"
+//! @member array(Parasite) "parasites"
//! @endmapping
array(Image.Layer) decode_layers( string|GimpImage|mapping what, mapping|void opts,
int|void concat )
@@ -664,27 +664,27 @@ array(Image.Layer) decode_layers( string|GimpImage|mapping what, mapping|void op
//! The options can contain one or more of these options:
//!
//! @mapping
-//! @member bool draw_all_layers
+//! @member bool "draw_all_layers"
//! If included, all layers will be decoded, even the non-visible ones.
-//! @member int shrink_fact
+//! @member int "shrink_fact"
//! Shrink the image by a factor of X. Useful for previews.
-//! @member bool draw_guides
+//! @member bool "draw_guides"
//! If true, draw the vertical and horizontal guides
-//! @member bool mark_layers
+//! @member bool "mark_layers"
//! If true, draw boxes around layers
-//! @member bool mark_layer_names
+//! @member bool "mark_layer_names"
//! If true, draw layer names in the image
-//! @member bool mark_active_layer
+//! @member bool "mark_active_layer"
//! If true, highlight the active layer
//! @endmapping
//!
//! The return value has this format:
//! @mapping
-//! @member string type
+//! @member string "type"
//! "image/x-gimp-image"
-//! @member Image.Image img
+//! @member Image.Image "img"
//! The image
-//! @member Image.Image alpha
+//! @member Image.Image "alpha"
//! The alpha channel
//! @endmapping
mapping(string:string|Image.Image) _decode( string|mapping|GimpImage what, mapping(string:mixed)|void opts )
diff --git a/lib/modules/_Image_XPM.pmod b/lib/modules/_Image_XPM.pmod
index 89d8d1ecd9..e4380f082a 100644
--- a/lib/modules/_Image_XPM.pmod
+++ b/lib/modules/_Image_XPM.pmod
@@ -29,9 +29,9 @@ int old_time,start_time;
//! Decode the given XPM image.
//!
//! @mapping
-//! @member Image.Image img
-//! @member Image.Image alpha
-//! @member string format
+//! @member Image.Image "img"
+//! @member Image.Image "alpha"
+//! @member string "format"
//! @endmapping
//!
//! No options are currently supported.
@@ -126,10 +126,10 @@ private array cmap_t;
//!
//! The supported options are:
//! @mapping
-//! @member string(1..128) name
-//! @member Image.Colortable colortable
-//! @member Image.Image alpha
-//! @member string(1..128) comment
+//! @member string(1..128) "name"
+//! @member Image.Colortable "colortable"
+//! @member Image.Image "alpha"
+//! @member string(1..128) "comment"
//! @endmapping
string encode( object what, mapping|void options )
diff --git a/src/modules/Image/encodings/hrz.c b/src/modules/Image/encodings/hrz.c
index 72ca29ab0b..fd549801ab 100644
--- a/src/modules/Image/encodings/hrz.c
+++ b/src/modules/Image/encodings/hrz.c
@@ -30,7 +30,7 @@ extern struct program *image_program;
**!
**! The HRZ file is always 256x240 with RGB values from 0 to 63.
**! No compression, no header, just the raw RGB data.
-**! HRZ is (was?) used for amatuer radio slow-scan TV.
+**! HRZ is (was?) used for amateur radio slow-scan TV.
*/
/*
diff --git a/src/post_modules/_Image_WebP/image_webp.cmod b/src/post_modules/_Image_WebP/image_webp.cmod
index 8faa36b60a..8cedebcbe6 100644
--- a/src/post_modules/_Image_WebP/image_webp.cmod
+++ b/src/post_modules/_Image_WebP/image_webp.cmod
@@ -204,12 +204,12 @@ static size_t Encode(const uint8_t* rgba, int width, int height, int stride,
*! @module WebP
*!
*! WebP is a truecolor image format with alpha channel support
- *! currently developed by google.
+ *! currently developed by Google.
*!
*! This module supports decoding and encoding of lossy and lossless
*! WebP images with and without alpha channels using the libwebp library.
*!
- *! WebP images are generally smaller than the same quality JPEG of
+ *! WebP images are generally smaller than the same quality JPEG or
*! PNG image, but takes longer to encode and decode, and support in
*! various applications is less common.
*!
@@ -221,11 +221,11 @@ static size_t Encode(const uint8_t* rgba, int width, int height, int stride,
*!
*! @returns
*! @mapping
- *! @member Image.Image alpha
- *! @member Image.Image image
- *! @member string format
- *! @member int(1..16384) width
- *! @member int(1..16384) height
+ *! @member Image.Image "alpha"
+ *! @member Image.Image "image"
+ *! @member string "format"
+ *! @member int(1..16384) "width"
+ *! @member int(1..16384) "height"
*! @endmapping
*/
@@ -335,16 +335,16 @@ static object *parameter_obj(struct mapping *map, const char *what )
*! Commonly used options:
*!
*! @mapping
- *! @member Image.Image alpha
+ *! @member Image.Image "alpha"
*! If present, the alpha channel for the image will be the green
*! component of this image. Has to be the same size as the @[image]
- *! @member int preset
+ *! @member int "preset"
*! Initialization for the encoding options.
*! One of PRESET_DEFAULT, PRESET_PICTURE, PRESET_PHOTO
*! PRESET_DRAWING, PRESET_ICON and PRESET_TEXT
- *! @member bool lossless
+ *! @member bool "lossless"
*! If set, do lossless encoding.
- *! @member float quality
+ *! @member float "quality"
*! Between 0 and 99. If quality is 100+, lossless encoding with
*! quality 70 will be used.
*! @endmapping
@@ -352,51 +352,52 @@ static object *parameter_obj(struct mapping *map, const char *what )
*! Additionally these advanced options are also supported:
*!
*! @mapping
- *! @member int image_hint
+ *! @member int "image_hint"
*! One of HINT_DEFAULT, HINT_PICTURE, HINT_PHOTO and HINT_GRAPH.
*! Only used in lossless mode
- *! @member int target_size
+ *! @member int "target_size"
*! If non zero, sets the desired filesize, in bytes. Takes
*! precedence over quality.
- *! @member int target_PSNR
+ *! @member int "target_PSNR"
*! if non-zero, specifies the minimal distortion to try to
*! achieve. Takes precedence over target_size.
- *! @member int(1..4) segments
+ *! @member int(1..4) "segments"
*! maximum number of segments to use.
- *! @member int(0..100) sns_strength
+ *! @member int(0..100) "sns_strength"
*! Spatial Noise Shaping. 0=off, 100=maximum.
- *! @member int(0..100) filter_strength
+ *! @member int(0..100) "filter_strength"
*! 0=off
- *! @member int(0..7) filter_sharpness
+ *! @member int(0..7) "filter_sharpness"
*! 0=off
- *! @member int(0..1) filter_type
+ *! @member int(0..1) "filter_type"
*! For the type, 0=simple, 1=strong.
*! @member bool autofilter
*! If true, automatically adjust the filter strengths
- *! @member int(0..1) alpha_compression
+ *! @member int(0..1) "alpha_compression"
*! Select alpha channel encoding format. Currently supported are 0: No alpha and 1: WebP lossless
- *! @member int(0..2) alpha_filtering
+ *! @member int(0..2) "alpha_filtering"
*! Select alpha filtering method. 0: none, 1: fast, 2: best. Default if 1.
- *! @member int(0..100) alpha_quality
+ *! @member int(0..100) "alpha_quality"
*! Select the base image quality for the alpha channel.
- *! @member int(1..10) pass
+ *! @member int(1..10) "pass"
*! The number of entropy analysis passes. Defaults to 1.
- *! @member bool show_compressed
- *! @member bool preprocessing
+ *! @member bool "show_compressed"
+ *!
+ *! @member bool "preprocessing"
*! If true, do preprocessing (segment-smooth)
- *! @member int(0..3) partitions
+ *! @member int(0..3) "partitions"
*! log2(number of token partitions). Default is set to 0 for easier
*! progressive decoding.
- *! @member int(0..100) partition_limit
+ *! @member int(0..100) "partition_limit"
*! quality degradation allowed to fit the 512k limit on prediction
*! modes coding (0: no degradation, 100: maximum possible
*! degradation).
- *! @member bool emulate_jpeg_size
+ *! @member bool "emulate_jpeg_size"
*! If true, try to map the quality setting to generate similar sizes
*! when compared to jpeg.
- *! @member int thread_level
+ *! @member int "thread_level"
*! The maximum number of extra threads to use. Defaults to 0
- *! @member bool low_memory
+ *! @member bool "low_memory"
*! Decrease memory usage at the cost of encoding speed
*! @endmapping
*!
--
GitLab