Skip to content

Commit 54963d5

Browse files
jcupittjcupitt
committed
revise docs in create
1 parent e8cdbe3 commit 54963d5

30 files changed

+110
-55
lines changed

‎doc/rename.sed

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ s/vips_\(exp10\)()/[method@Image.\1]/g
156156
s/vips_\(exp\)()/[method@Image.\1]/g
157157
s/vips_\(extract_area\)()/[method@Image.\1]/g
158158
s/vips_\(extract_band\)()/[method@Image.\1]/g
159+
s/vips_\(eye\)()/[ctor@Image.\1]/g
159160
s/vips_\(falsecolour\)()/[method@Image.\1]/g
160161
s/vips_\(fastcor\)()/[method@Image.\1]/g
161162
s/vips_\(fill_nearest\)()/[method@Image.\1]/g
@@ -167,17 +168,21 @@ s/vips_\(flatten\)()/[method@Image.\1]/g
167168
s/vips_\(flip\)()/[method@Image.\1]/g
168169
s/vips_\(float2rad\)()/[method@Image.\1]/g
169170
s/vips_\(floor\)()/[method@Image.\1]/g
171+
s/vips_\(fractsurf\)()/[ctor@Image.\1]/g
170172
s/vips_\(freqmult\)()/[method@Image.\1]/g
171173
s/vips_\(fwfft\)()/[method@Image.\1]/g
172174
s/vips_\(gamma\)()/[method@Image.\1]/g
173175
s/vips_\(gaussblur\)()/[method@Image.\1]/g
176+
s/vips_\(gaussmat\)()/[ctor@Image.\1]/g
177+
s/vips_\(gaussnoise\)()/[ctor@Image.\1]/g
174178
s/vips_\(getpoint\)()/[method@Image.\1]/g
175179
s/vips_\(get_tile_size\)()/[method@Image.\1]/g
176180
s/vips_\(gifsave_buffer\)()/[method@Image.\1]/g
177181
s/vips_\(gifsave\)()/[method@Image.\1]/g
178182
s/vips_\(gifsave_target\)()/[method@Image.\1]/g
179183
s/vips_\(globalbalance\)()/[method@Image.\1]/g
180184
s/vips_\(gravity\)()/[method@Image.\1]/g
185+
s/vips_\(grey\)()/[ctor@Image.\1]/g
181186
s/vips_\(grid\)()/[method@Image.\1]/g
182187
s/vips_\(heifsave_buffer\)()/[method@Image.\1]/g
183188
s/vips_\(heifsave\)()/[method@Image.\1]/g
@@ -199,6 +204,7 @@ s/vips_\(HSV2sRGB\)()/[method@Image.\1]/g
199204
s/vips_\(icc_export\)()/[method@Image.\1]/g
200205
s/vips_\(icc_import\)()/[method@Image.\1]/g
201206
s/vips_\(icc_transform\)()/[method@Image.\1]/g
207+
s/vips_\(identity\)()/[ctor@Image.\1]/g
202208
s/vips_\(ifthenelse\)()/[method@Image.\1]/g
203209
s/vips_image_\(get_typeof\)()/[method@Image.\1]/g
204210
s/vips_\(imag\)()/[method@Image.\1]/g
@@ -240,6 +246,7 @@ s/vips_\(linear1\)()/[method@Image.\1]/g
240246
s/vips_\(linear\)()/[method@Image.\1]/g
241247
s/vips_\(linecache\)()/[method@Image.\1]/g
242248
s/vips_\(log10\)()/[method@Image.\1]/g
249+
s/vips_\(logmat\)()/[ctor@Image.\1]/g
243250
s/vips_\(log\)()/[method@Image.\1]/g
244251
s/vips_\(lshift_const1\)()/[method@Image.\1]/g
245252
s/vips_\(lshift_const\)()/[method@Image.\1]/g
@@ -248,6 +255,16 @@ s/vips_\(magicksave_buffer\)()/[method@Image.\1]/g
248255
s/vips_\(magicksave\)()/[method@Image.\1]/g
249256
s/vips_\(mapim\)()/[method@Image.\1]/g
250257
s/vips_\(maplut\)()/[method@Image.\1]/g
258+
s/vips_\(mask_butterworth_band\)()/[ctor@Image.\1]/g
259+
s/vips_\(mask_butterworth\)()/[ctor@Image.\1]/g
260+
s/vips_\(mask_butterworth_ring\)()/[ctor@Image.\1]/g
261+
s/vips_\(mask_fractal\)()/[ctor@Image.\1]/g
262+
s/vips_\(mask_gaussian_band\)()/[ctor@Image.\1]/g
263+
s/vips_\(mask_gaussian\)()/[ctor@Image.\1]/g
264+
s/vips_\(mask_gaussian_ring\)()/[ctor@Image.\1]/g
265+
s/vips_\(mask_ideal_band\)()/[ctor@Image.\1]/g
266+
s/vips_\(mask_ideal\)()/[ctor@Image.\1]/g
267+
s/vips_\(mask_ideal_ring\)()/[ctor@Image.\1]/g
251268
s/vips_\(match\)()/[method@Image.\1]/g
252269
s/vips_\(math2_const1\)()/[method@Image.\1]/g
253270
s/vips_\(math2_const\)()/[method@Image.\1]/g
@@ -284,6 +301,7 @@ s/vips_\(orimage_const1\)()/[method@Image.\1]/g
284301
s/vips_\(orimage_const\)()/[method@Image.\1]/g
285302
s/vips_\(orimage\)()/[method@Image.\1]/g
286303
s/vips_\(percent\)()/[method@Image.\1]/g
304+
s/vips_\(perlin\)()/[ctor@Image.\1]/g
287305
s/vips_\(phasecor\)()/[method@Image.\1]/g
288306
s/vips_\(pngsave_buffer\)()/[method@Image.\1]/g
289307
s/vips_\(pngsave\)()/[method@Image.\1]/g
@@ -359,11 +377,13 @@ s/vips_\(subsample\)()/[method@Image.\1]/g
359377
s/vips_\(subtract\)()/[method@Image.\1]/g
360378
s/vips_\(tanh\)()/[method@Image.\1]/g
361379
s/vips_\(tan\)()/[method@Image.\1]/g
380+
s/vips_\(text\)()/[ctor@Image.\1]/g
362381
s/vips_\(thumbnail_image\)()/[method@Image.\1]/g
363382
s/vips_\(tiffsave_buffer\)()/[method@Image.\1]/g
364383
s/vips_\(tiffsave\)()/[method@Image.\1]/g
365384
s/vips_\(tiffsave_target\)()/[method@Image.\1]/g
366385
s/vips_\(tilecache\)()/[method@Image.\1]/g
386+
s/vips_\(tonelut\)()/[ctor@Image.\1]/g
367387
s/vips_\(transpose3d\)()/[method@Image.\1]/g
368388
s/vips_\(unpremultiply\)()/[method@Image.\1]/g
369389
s/vips_\(vipssave\)()/[method@Image.\1]/g
@@ -373,12 +393,15 @@ s/vips_\(webpsave\)()/[method@Image.\1]/g
373393
s/vips_\(webpsave_mime\)()/[method@Image.\1]/g
374394
s/vips_\(webpsave_target\)()/[method@Image.\1]/g
375395
s/vips_\(wop\)()/[method@Image.\1]/g
396+
s/vips_\(worley\)()/[ctor@Image.\1]/g
376397
s/vips_\(wrap\)()/[method@Image.\1]/g
377398
s/vips_\(XYZ2CMYK\)()/[method@Image.\1]/g
378399
s/vips_\(XYZ2Lab\)()/[method@Image.\1]/g
379400
s/vips_\(XYZ2scRGB\)()/[method@Image.\1]/g
380401
s/vips_\(XYZ2Yxy\)()/[method@Image.\1]/g
402+
s/vips_\(xyz\)()/[ctor@Image.\1]/g
381403
s/vips_\(Yxy2XYZ\)()/[method@Image.\1]/g
404+
s/vips_\(zone\)()/[ctor@Image.\1]/g
382405
s/vips_\(zoom\)()/[method@Image.\1]/g
383406

384407
s/vips_\([^(]*\)()/[func@\1]/g

‎libvips/create/black.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,8 @@ vips_black_init(VipsBlack *black)
177177
*
178178
* Make a black unsigned char image of a specified size.
179179
*
180-
* See also: vips_xyz(), vips_text(), vips_gaussnoise().
180+
* ::: seealso
181+
* [ctor@Image.xyz], [ctor@Image.text], [ctor@Image.gaussnoise].
181182
*
182183
* Returns: 0 on success, -1 on error
183184
*/

‎libvips/create/buildlut.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,8 @@ vips_buildlut_init(VipsBuildlut *lut)
279279
*
280280
* This operation builds a lookup table from a set of points. Intermediate
281281
* values are generated by piecewise linear interpolation. The lookup table is
282-
* always of type #VIPS_FORMAT_DOUBLE, use vips_cast() to change it to the
283-
* type you need.
282+
* always of type [enum@Vips.BandFormat.DOUBLE], use [method@Image.cast] to
283+
* change it to the type you need.
284284
*
285285
* For example, consider this 2 x 2 matrix of (x, y) coordinates:
286286
*
@@ -306,7 +306,9 @@ vips_buildlut_init(VipsBuildlut *lut)
306306
* several Ys, each becomes a band in the output LUT. You don't need to
307307
* start at zero, any integer will do, including negatives.
308308
*
309-
* See also: vips_identity(), vips_invertlut(), vips_cast(), vips_maplut().
309+
* ::: seealso
310+
* [ctor@Image.identity], [method@Image.invertlut], [method@Image.cast],
311+
* [method@Image.maplut].
310312
*
311313
* Returns: 0 on success, -1 on error
312314
*/

‎libvips/create/create.c

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,11 @@
5858
* @VIPS_TEXT_WRAP_WORD_CHAR: wrap at word boundaries, but fall back to character boundaries if there is not enough space for a full word
5959
* @VIPS_TEXT_WRAP_NONE: no wrapping
6060
*
61-
* Sets the word wrapping style for vips_text() when used with a maximum
61+
* Sets the word wrapping style for [ctor@Image.text] when used with a maximum
6262
* width.
6363
*
64-
* See also: vips_text().
64+
* ::: seealso
65+
* [ctor@Image.text].
6566
*/
6667

6768
/**
@@ -73,7 +74,8 @@
7374
*
7475
* The SDF to generate,
7576
*
76-
* See also: vips_sdf().
77+
* ::: seealso
78+
* [ctor@Image.sdf].
7779
*/
7880

7981
G_DEFINE_ABSTRACT_TYPE(VipsCreate, vips_create, VIPS_TYPE_OPERATION);
@@ -160,9 +162,11 @@ vips_create_operation_init(void)
160162
vips_gaussmat_get_type();
161163
vips_logmat_get_type();
162164
vips_gaussnoise_get_type();
165+
163166
#ifdef HAVE_PANGOCAIRO
164167
vips_text_get_type();
165168
#endif /*HAVE_PANGOCAIRO*/
169+
166170
vips_xyz_get_type();
167171
vips_sdf_get_type();
168172
vips_eye_get_type();

‎libvips/create/eye.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@ vips_eye_init(VipsEye *eye)
136136
*
137137
* Set @uchar to output a uchar image.
138138
*
139-
* See also: vips_zone().
139+
* ::: seealso
140+
* [ctor@Image.zone].
140141
*
141142
* Returns: 0 on success, -1 on error
142143
*/

‎libvips/create/fractsurf.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,8 @@ vips_fractsurf_init(VipsFractsurf *fractsurf)
141141
* Generate an image of size @width by @height and fractal dimension
142142
* @fractal_dimension. The dimension should be between 2 and 3.
143143
*
144-
* See also: vips_gaussnoise(), vips_mask_fractal().
144+
* ::: seealso
145+
* [ctor@Image.gaussnoise], [ctor@Image.mask_fractal].
145146
*
146147
* Returns: 0 on success, -1 on error
147148
*/

‎libvips/create/gaussmat.c

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ vips_gaussmat_init(VipsGaussmat *gaussmat)
235235
* Optional arguments:
236236
*
237237
* * @separable: generate a separable gaussian
238-
* * @precision: #VipsPrecision for @out
238+
* * @precision: [enum@Precision] for @out
239239
*
240240
* Creates a circularly symmetric Gaussian image of radius
241241
* @sigma. The size of the mask is determined by the variable @min_ampl;
@@ -247,17 +247,18 @@ vips_gaussmat_init(VipsGaussmat *gaussmat)
247247
* H(r) = exp(-(r * r) / (2 * @sigma * @sigma))
248248
*
249249
* The generated image has odd size and its maximum value is normalised to
250-
* 1.0, unless @precision is #VIPS_PRECISION_INTEGER.
250+
* 1.0, unless @precision is [enum@Vips.Precision.INTEGER].
251251
*
252252
* If @separable is set, only the centre horizontal is generated. This is
253253
* useful for separable convolutions.
254254
*
255-
* If @precision is #VIPS_PRECISION_INTEGER, an integer gaussian is generated.
255+
* If @precision is [enum@Vips.Precision.INTEGER], an integer gaussian is generated.
256256
* This is useful for integer convolutions.
257257
*
258258
* "scale" is set to the sum of all the mask elements.
259259
*
260-
* See also: vips_logmat(), vips_conv().
260+
* ::: seealso
261+
* [ctor@Image.logmat], [method@Image.conv].
261262
*
262263
* Returns: 0 on success, -1 on error
263264
*/

‎libvips/create/gaussnoise.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,8 @@ vips_gaussnoise_init(VipsGaussnoise *gaussnoise)
224224
* distribution. The noise distribution is created by averaging 12 random
225225
* numbers with the appropriate weights.
226226
*
227-
* See also: vips_black(), vips_xyz(), vips_text().
227+
* ::: seealso
228+
* [ctor@Image.black], [ctor@Image.xyz], [ctor@Image.text].
228229
*
229230
* Returns: 0 on success, -1 on error
230231
*/

‎libvips/create/grey.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ vips_grey_init(VipsGrey *grey)
115115
* Set @uchar to output a uchar image with the leftmost pixel 0 and the
116116
* rightmost 255.
117117
*
118-
* See also: vips_xyz(), vips_identity().
118+
* ::: seealso
119+
* [ctor@Image.xyz], [ctor@Image.identity].
119120
*
120121
* Returns: 0 on success, -1 on error
121122
*/

‎libvips/create/identity.c

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ vips_identity_init(VipsIdentity *identity)
181181
* * @size: number of LUT elements for a ushort image
182182
*
183183
* Creates an identity lookup table, ie. one which will leave an image
184-
* unchanged when applied with vips_maplut(). Each entry in the table has a
184+
* unchanged when applied with [method@Image.maplut]. Each entry in the table has a
185185
* value equal to its position.
186186
*
187187
* Use the arithmetic operations on these tables to make LUTs representing
@@ -192,7 +192,8 @@ vips_identity_init(VipsIdentity *identity)
192192
* Normally 16-bit tables have 65536 entries. You can set this smaller with
193193
* @size.
194194
*
195-
* See also: vips_xyz(), vips_maplut().
195+
* ::: seealso
196+
* [ctor@Image.xyz], [method@Image.maplut].
196197
*
197198
* Returns: 0 on success, -1 on error
198199
*/

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy