Skip to content

Commit d53b8a7

Browse files
kleisaukekleisauke
authored
doc: minor gi-docgen improvements (#4473)
* doc: unify `seealso` admonitions with other files * doc: use spaces instead of tabs * doc: port hyperlinks to Markdown * doc: port tables to Markdown * doc: port emphasis to Markdown * doc: port functions and types to gi-docgen linking syntax
1 parent d5fb816 commit d53b8a7

32 files changed

+184
-458
lines changed

‎libvips/arithmetic/abs.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ vips_abs_init(VipsAbs *abs)
218218
*
219219
* This operation finds the absolute value of an image. It does a copy for
220220
* unsigned integer types, negate for negative values in
221-
* signed integer types, <function>fabs(3)</function> for
221+
* signed integer types, [`fabs()`](man:fabs(3)) for
222222
* float types, and calculates modulus for complex
223223
* types.
224224
*

‎libvips/arithmetic/add.c

Lines changed: 15 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -206,62 +206,23 @@ vips_add_init(VipsAdd *add)
206206
*
207207
* The two input images are cast up to the smallest common format (see table
208208
* Smallest common format in
209-
* <link linkend="libvips-arithmetic">arithmetic</link>), then the
209+
* [arithmetic](libvips-arithmetic.html)), then the
210210
* following table is used to determine the output type:
211211
*
212-
* <table>
213-
* <title>VipsAdd type promotion</title>
214-
* <tgroup cols='2' align='left' colsep='1' rowsep='1'>
215-
* <thead>
216-
* <row>
217-
* <entry>input type</entry>
218-
* <entry>output type</entry>
219-
* </row>
220-
* </thead>
221-
* <tbody>
222-
* <row>
223-
* <entry>uchar</entry>
224-
* <entry>ushort</entry>
225-
* </row>
226-
* <row>
227-
* <entry>char</entry>
228-
* <entry>short</entry>
229-
* </row>
230-
* <row>
231-
* <entry>ushort</entry>
232-
* <entry>uint</entry>
233-
* </row>
234-
* <row>
235-
* <entry>short</entry>
236-
* <entry>int</entry>
237-
* </row>
238-
* <row>
239-
* <entry>uint</entry>
240-
* <entry>uint</entry>
241-
* </row>
242-
* <row>
243-
* <entry>int</entry>
244-
* <entry>int</entry>
245-
* </row>
246-
* <row>
247-
* <entry>float</entry>
248-
* <entry>float</entry>
249-
* </row>
250-
* <row>
251-
* <entry>double</entry>
252-
* <entry>double</entry>
253-
* </row>
254-
* <row>
255-
* <entry>complex</entry>
256-
* <entry>complex</entry>
257-
* </row>
258-
* <row>
259-
* <entry>double complex</entry>
260-
* <entry>double complex</entry>
261-
* </row>
262-
* </tbody>
263-
* </tgroup>
264-
* </table>
212+
* ## [method@Image.add] type promotion
213+
*
214+
* | input type | output type |
215+
* |----------------|----------------|
216+
* | uchar | ushort |
217+
* | char | short |
218+
* | ushort | uint |
219+
* | short | int |
220+
* | uint | uint |
221+
* | int | int |
222+
* | float | float |
223+
* | double | double |
224+
* | complex | complex |
225+
* | double complex | double complex |
265226
*
266227
* In other words, the output type is just large enough to hold the whole
267228
* range of possible values.

‎libvips/arithmetic/boolean.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ vips_booleanv(VipsImage *left, VipsImage *right, VipsImage **out,
318318
*
319319
* The two input images are cast up to the smallest common format (see table
320320
* Smallest common format in
321-
* <link linkend="libvips-arithmetic">arithmetic</link>).
321+
* [arithmetic](libvips-arithmetic.html)).
322322
*
323323
* ::: seealso
324324
* [method@Image.boolean_const].

‎libvips/arithmetic/divide.c

Lines changed: 15 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -239,62 +239,23 @@ vips_divide_init(VipsDivide *divide)
239239
*
240240
* The two input images are cast up to the smallest common format (see table
241241
* Smallest common format in
242-
* <link linkend="libvips-arithmetic">arithmetic</link>), then the
242+
* [arithmetic](libvips-arithmetic.html)), then the
243243
* following table is used to determine the output type:
244244
*
245-
* <table>
246-
* <title>[method@Image.divide] type promotion</title>
247-
* <tgroup cols='2' align='left' colsep='1' rowsep='1'>
248-
* <thead>
249-
* <row>
250-
* <entry>input type</entry>
251-
* <entry>output type</entry>
252-
* </row>
253-
* </thead>
254-
* <tbody>
255-
* <row>
256-
* <entry>uchar</entry>
257-
* <entry>float</entry>
258-
* </row>
259-
* <row>
260-
* <entry>char</entry>
261-
* <entry>float</entry>
262-
* </row>
263-
* <row>
264-
* <entry>ushort</entry>
265-
* <entry>float</entry>
266-
* </row>
267-
* <row>
268-
* <entry>short</entry>
269-
* <entry>float</entry>
270-
* </row>
271-
* <row>
272-
* <entry>uint</entry>
273-
* <entry>float</entry>
274-
* </row>
275-
* <row>
276-
* <entry>int</entry>
277-
* <entry>float</entry>
278-
* </row>
279-
* <row>
280-
* <entry>float</entry>
281-
* <entry>float</entry>
282-
* </row>
283-
* <row>
284-
* <entry>double</entry>
285-
* <entry>double</entry>
286-
* </row>
287-
* <row>
288-
* <entry>complex</entry>
289-
* <entry>complex</entry>
290-
* </row>
291-
* <row>
292-
* <entry>double complex</entry>
293-
* <entry>double complex</entry>
294-
* </row>
295-
* </tbody>
296-
* </tgroup>
297-
* </table>
245+
* ## [method@Image.divide] type promotion
246+
*
247+
* | input type | output type |
248+
* |----------------|----------------|
249+
* | uchar | float |
250+
* | char | float |
251+
* | ushort | float |
252+
* | short | float |
253+
* | uint | float |
254+
* | int | float |
255+
* | float | float |
256+
* | double | double |
257+
* | complex | complex |
258+
* | double complex | double complex |
298259
*
299260
* In other words, the output type is just large enough to hold the whole
300261
* range of possible values.

‎libvips/arithmetic/linear.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -550,7 +550,7 @@ vips_linear(VipsImage *in, VipsImage **out,
550550
* Run [method@Image.linear] with a single constant.
551551
*
552552
* ::: tip "Optional arguments"
553-
* * @uchar: output uchar pixels
553+
* * @uchar: output uchar pixels
554554
*
555555
* ::: seealso
556556
* [method@Image.linear].

‎libvips/arithmetic/math2.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ vips_math2v(VipsImage *left, VipsImage *right, VipsImage **out,
283283
*
284284
* The two input images are cast up to the smallest common format (see table
285285
* Smallest common format in
286-
* <link linkend="libvips-arithmetic">arithmetic</link>), and that format is the
286+
* [arithmetic](libvips-arithmetic.html)), and that format is the
287287
* result type.
288288
*
289289
* ::: seealso

‎libvips/arithmetic/multiply.c

Lines changed: 15 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -223,62 +223,23 @@ vips_multiply_init(VipsMultiply *multiply)
223223
*
224224
* The two input images are cast up to the smallest common format (see table
225225
* Smallest common format in
226-
* <link linkend="libvips-arithmetic">arithmetic</link>), then the
226+
* [arithmetic](libvips-arithmetic.html)), then the
227227
* following table is used to determine the output type:
228228
*
229-
* <table>
230-
* <title>VipsMultiply type promotion</title>
231-
* <tgroup cols='2' align='left' colsep='1' rowsep='1'>
232-
* <thead>
233-
* <row>
234-
* <entry>input type</entry>
235-
* <entry>output type</entry>
236-
* </row>
237-
* </thead>
238-
* <tbody>
239-
* <row>
240-
* <entry>uchar</entry>
241-
* <entry>ushort</entry>
242-
* </row>
243-
* <row>
244-
* <entry>char</entry>
245-
* <entry>short</entry>
246-
* </row>
247-
* <row>
248-
* <entry>ushort</entry>
249-
* <entry>uint</entry>
250-
* </row>
251-
* <row>
252-
* <entry>short</entry>
253-
* <entry>int</entry>
254-
* </row>
255-
* <row>
256-
* <entry>uint</entry>
257-
* <entry>uint</entry>
258-
* </row>
259-
* <row>
260-
* <entry>int</entry>
261-
* <entry>int</entry>
262-
* </row>
263-
* <row>
264-
* <entry>float</entry>
265-
* <entry>float</entry>
266-
* </row>
267-
* <row>
268-
* <entry>double</entry>
269-
* <entry>double</entry>
270-
* </row>
271-
* <row>
272-
* <entry>complex</entry>
273-
* <entry>complex</entry>
274-
* </row>
275-
* <row>
276-
* <entry>double complex</entry>
277-
* <entry>double complex</entry>
278-
* </row>
279-
* </tbody>
280-
* </tgroup>
281-
* </table>
229+
* ## [method@Image.multiply] type promotion
230+
*
231+
* | input type | output type |
232+
* |----------------|----------------|
233+
* | uchar | ushort |
234+
* | char | short |
235+
* | ushort | uint |
236+
* | short | int |
237+
* | uint | uint |
238+
* | int | int |
239+
* | float | float |
240+
* | double | double |
241+
* | complex | complex |
242+
* | double complex | double complex |
282243
*
283244
* In other words, the output type is just large enough to hold the whole
284245
* range of possible values.

‎libvips/arithmetic/relational.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ vips_relationalv(VipsImage *left, VipsImage *right, VipsImage **out,
288288
*
289289
* The two input images are cast up to the smallest common format (see table
290290
* Smallest common format in
291-
* <link linkend="libvips-arithmetic">arithmetic</link>).
291+
* [arithmetic](libvips-arithmetic.html)).
292292
*
293293
* To decide if pixels match exactly, that is have the same value in every
294294
* band, use [method@Image.bandbool] after this operation to AND or OR image bands

‎libvips/arithmetic/remainder.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ vips_remainder_init(VipsRemainder *remainder)
225225
*
226226
* The two input images are cast up to the smallest common format (see table
227227
* Smallest common format in
228-
* <link linkend="libvips-arithmetic">arithmetic</link>), and that format is the
228+
* [arithmetic](libvips-arithmetic.html)), and that format is the
229229
* result type.
230230
*
231231
* ::: seealso

‎libvips/arithmetic/subtract.c

Lines changed: 15 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -202,62 +202,23 @@ vips_subtract_init(VipsSubtract *subtract)
202202
*
203203
* The two input images are cast up to the smallest common format (see table
204204
* Smallest common format in
205-
* <link linkend="libvips-arithmetic">arithmetic</link>), then the
205+
* [arithmetic](libvips-arithmetic.html)), then the
206206
* following table is used to determine the output type:
207207
*
208-
* <table>
209-
* <title>VipsSubtract type promotion</title>
210-
* <tgroup cols='2' align='left' colsep='1' rowsep='1'>
211-
* <thead>
212-
* <row>
213-
* <entry>input type</entry>
214-
* <entry>output type</entry>
215-
* </row>
216-
* </thead>
217-
* <tbody>
218-
* <row>
219-
* <entry>uchar</entry>
220-
* <entry>short</entry>
221-
* </row>
222-
* <row>
223-
* <entry>char</entry>
224-
* <entry>short</entry>
225-
* </row>
226-
* <row>
227-
* <entry>ushort</entry>
228-
* <entry>int</entry>
229-
* </row>
230-
* <row>
231-
* <entry>short</entry>
232-
* <entry>int</entry>
233-
* </row>
234-
* <row>
235-
* <entry>uint</entry>
236-
* <entry>int</entry>
237-
* </row>
238-
* <row>
239-
* <entry>int</entry>
240-
* <entry>int</entry>
241-
* </row>
242-
* <row>
243-
* <entry>float</entry>
244-
* <entry>float</entry>
245-
* </row>
246-
* <row>
247-
* <entry>double</entry>
248-
* <entry>double</entry>
249-
* </row>
250-
* <row>
251-
* <entry>complex</entry>
252-
* <entry>complex</entry>
253-
* </row>
254-
* <row>
255-
* <entry>double complex</entry>
256-
* <entry>double complex</entry>
257-
* </row>
258-
* </tbody>
259-
* </tgroup>
260-
* </table>
208+
* ## [method@Image.subtract] type promotion
209+
*
210+
* | input type | output type |
211+
* |----------------|----------------|
212+
* | uchar | short |
213+
* | char | short |
214+
* | ushort | int |
215+
* | short | int |
216+
* | uint | int |
217+
* | int | int |
218+
* | float | float |
219+
* | double | double |
220+
* | complex | complex |
221+
* | double complex | double complex |
261222
*
262223
* In other words, the output type is just large enough to hold the whole
263224
* range of possible values.

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