From 914411d8ab004e1c67b9307a3d94cb3fc132d763 Mon Sep 17 00:00:00 2001 From: Mike Wey Date: Sun, 11 Sep 2011 21:25:45 +0200 Subject: Improve the generated documentation. --- dmagick/Image.d | 49 +++++++++++++++++++++---------------------------- 1 file changed, 21 insertions(+), 28 deletions(-) (limited to 'dmagick') diff --git a/dmagick/Image.d b/dmagick/Image.d index e212d83..effc7e7 100644 --- a/dmagick/Image.d +++ b/dmagick/Image.d @@ -2,15 +2,6 @@ * Copyright: Mike Wey 2011 * License: zlib (See accompanying LICENSE file) * Authors: Mike Wey - * - * Macros: - * TABLE=$0
- * - * TH=$1$(TH $+) - * HEADERS=$(TH $1, $+) - * - * TD=$1$(TD $+) - * ROW=$(TD $1, $+) */ module dmagick.Image; @@ -146,16 +137,16 @@ class Image * Constructs an image from an array of pixels. * * Params: - * width = The number of columns in the image. - * height = The number of rows in the image. - * map = A string describing the expected ordering - * of the pixel array. It can be any combination - * or order of R = red, G = green, B = blue, A = alpha - * , C = cyan, Y = yellow, M = magenta, K = black, - * or I = intensity (for grayscale). - * storage = The pixel Staroage type (CharPixel, - * ShortPixel, IntegerPixel, FloatPixel, or DoublePixel). - * pixels = The pixel data. + * columns = The number of columns in the image. + * rows = The number of rows in the image. + * map = A string describing the expected ordering + * of the pixel array. It can be any combination + * or order of R = red, G = green, B = blue, A = alpha + * , C = cyan, Y = yellow, M = magenta, K = black, + * or I = intensity (for grayscale). + * storage = The pixel Staroage type (CharPixel, + * ShortPixel, IntegerPixel, FloatPixel, or DoublePixel). + * pixels = The pixel data. */ this(size_t columns, size_t rows, string map, StorageType storage, void[] pixels) { @@ -170,14 +161,16 @@ class Image /** * Constructs a description of the image as a string. * The string contains some or all of the following fields: - * $(B filename) The current filename. $(BR) - * $(B [scene]) The scene number, if the image is part of a secuence. $(BR) - * $(B format) The image format. $(BR) - * $(B width x height) $(BR) - * $(B page width x height + xOffset + yOffset) $(BR) - * $(B classType) DirectClass or PseudoClass $(BR) - * $(B N-bit) bit depth. $(BR) - * $(B blob size) if present. + * $(LIST + * $(B filename) The current filename., + * $(B [scene]) The scene number if the image is part of a secuence., + * $(B format) The image format., + * $(B width x height), + * $(B page width x height + xOffset + yOffset), + * $(B classType) DirectClass or PseudoClass, + * $(B N-bit) bit depth., + * $(B blob size) if present. + * ) */ string toString() { @@ -3803,7 +3796,7 @@ class Image * will periodically call the monitor with arguments indicating the * progress of the method. * - * The delegate receves the folowing params: $(BR) + * The delegate receves the folowing $(B parameters): $(BR) * $(TABLE * $(ROW string $(I methodName), The name of the monitored method.) * $(ROW long $(I offset ), A number between 0 and extent that -- cgit v1.2.3