update docs in freqfilt

jcupitt · jcupitt · commit 0407285a19da · 2025-04-27T11:51:11.000+01:00
diff --git a/libvips/freqfilt/freqfilt.c b/libvips/freqfilt/freqfilt.c
@@ -116,8 +116,8 @@ vips_freqfilt_init(VipsFreqfilt *freqfilt)
  *             partial bandjoin ->
  *               output pipeline
  *
- * vips__fftproc() needs to just call VipsFftProcessFn directly for 1 band images,
- * so we can't cache the output in this fn.
+ * vips__fftproc() needs to just call VipsFftProcessFn directly for 1 band
+ * images, so we can't cache the output in this fn.
  */
 int
 vips__fftproc(VipsObject *context,
diff --git a/libvips/freqfilt/freqmult.c b/libvips/freqfilt/freqmult.c
@@ -151,7 +151,8 @@ vips_freqmult_init(VipsFreqmult *freqmult)
  * transformed back to real space. If @in is already a complex image, just
  * multiply then inverse transform.
  *
- * See also: vips_invfft(), vips_mask_ideal().
+ * ::: seealso
+ *     [method@Image.invfft], [ctor@Image.mask_ideal].
  *
  * Returns: 0 on success, -1 on error.
  */
diff --git a/libvips/freqfilt/fwfft.c b/libvips/freqfilt/fwfft.c
@@ -370,7 +370,8 @@ vips_fwfft_init(VipsFwfft *fwfft)
  * VIPS uses the fftw Fourier Transform library. If this library was not
  * available when VIPS was configured, these functions will fail.
  *
- * See also: vips_invfft().
+ * ::: seealso
+ *     [method@Image.invfft].
  *
  * Returns: 0 on success, -1 on error.
  */
diff --git a/libvips/freqfilt/invfft.c b/libvips/freqfilt/invfft.c
@@ -284,17 +284,19 @@ vips_invfft_init(VipsInvfft *invfft)
  * @out: (out): output image
  * @...: %NULL-terminated list of optional named arguments
  *
- * Optional arguments:
+ * Transform an image from Fourier space to real space.
  *
- * * @real: only output the real part
- *
- * Transform an image from Fourier space to real space. The result is complex.
- * If you are OK with a real result, set @real, it's quicker.
+ * The result is complex. If you are OK with a real result, set @real,
+ * it's quicker.
  *
  * VIPS uses the fftw Fourier Transform library. If this library was not
  * available when VIPS was configured, these functions will fail.
  *
- * See also: vips_fwfft().
+ * ::: tip "Optional arguments"
+ *     * @real: %gboolean, only output the real part
+ *
+ * ::: seealso
+ *     [method@Image.fwfft].
  *
  * Returns: 0 on success, -1 on error.
  */
diff --git a/libvips/freqfilt/phasecor.c b/libvips/freqfilt/phasecor.c
@@ -129,7 +129,8 @@ vips_phasecor_init(VipsPhasecor *phasecor)
  * Convert the two input images to Fourier space, calculate phase-correlation,
  * back to real space.
  *
- * See also: vips_fwfft(), vips_cross_phase(),
+ * ::: seealso
+ *     [method@Image.fwfft], [method@Image.cross_phase],
  *
  * Returns: 0 on success, -1 on error.
  */
diff --git a/libvips/freqfilt/spectrum.c b/libvips/freqfilt/spectrum.c
@@ -115,9 +115,11 @@ vips_spectrum_init(VipsSpectrum *spectrum)
  * Make a displayable (ie. 8-bit unsigned int) power spectrum.
  *
  * If @in is non-complex, it is transformed to Fourier space. Then the
- * absolute value is passed through vips_scale() in log mode, and vips_wrap().
+ * absolute value is passed through [method@Image.scale] in log mode, and
+ * [method@Image.wrap].
  *
- * See also: vips_fwfft(), vips_scale(), vips_wrap().
+ * ::: seealso
+ *     [method@Image.fwfft], [method@Image.scale], [method@Image.wrap].
  *
  * Returns: 0 on success, -1 on error.
  */

Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,8 @@ vips_freqmult_init(VipsFreqmult *freqmult)`
`151`	`151`	`* transformed back to real space. If @in is already a complex image, just`
`152`	`152`	`* multiply then inverse transform.`
`153`	`153`	`*`
`154`		`- * See also: vips_invfft(), vips_mask_ideal().`
	`154`	`+ * ::: seealso`
	`155`	`+ * [method@Image.invfft], [ctor@Image.mask_ideal].`
`155`	`156`	`*`
`156`	`157`	`* Returns: 0 on success, -1 on error.`
`157`	`158`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -370,7 +370,8 @@ vips_fwfft_init(VipsFwfft *fwfft)`
`370`	`370`	`* VIPS uses the fftw Fourier Transform library. If this library was not`
`371`	`371`	`* available when VIPS was configured, these functions will fail.`
`372`	`372`	`*`
`373`		`- * See also: vips_invfft().`
	`373`	`+ * ::: seealso`
	`374`	`+ * [method@Image.invfft].`
`374`	`375`	`*`
`375`	`376`	`* Returns: 0 on success, -1 on error.`
`376`	`377`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -284,17 +284,19 @@ vips_invfft_init(VipsInvfft *invfft)`
`284`	`284`	`* @out: (out): output image`
`285`	`285`	`* @...: %NULL-terminated list of optional named arguments`
`286`	`286`	`*`
`287`		`- * Optional arguments:`
	`287`	`+ * Transform an image from Fourier space to real space.`
`288`	`288`	`*`
`289`		`- * * @real: only output the real part`
`290`		`- *`
`291`		`- * Transform an image from Fourier space to real space. The result is complex.`
`292`		`- * If you are OK with a real result, set @real, it's quicker.`
	`289`	`+ * The result is complex. If you are OK with a real result, set @real,`
	`290`	`+ * it's quicker.`
`293`	`291`	`*`
`294`	`292`	`* VIPS uses the fftw Fourier Transform library. If this library was not`
`295`	`293`	`* available when VIPS was configured, these functions will fail.`
`296`	`294`	`*`
`297`		`- * See also: vips_fwfft().`
	`295`	`+ * ::: tip "Optional arguments"`
	`296`	`+ * * @real: %gboolean, only output the real part`
	`297`	`+ *`
	`298`	`+ * ::: seealso`
	`299`	`+ * [method@Image.fwfft].`
`298`	`300`	`*`
`299`	`301`	`* Returns: 0 on success, -1 on error.`
`300`	`302`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,8 @@ vips_phasecor_init(VipsPhasecor *phasecor)`
`129`	`129`	`* Convert the two input images to Fourier space, calculate phase-correlation,`
`130`	`130`	`* back to real space.`
`131`	`131`	`*`
`132`		`- * See also: vips_fwfft(), vips_cross_phase(),`
	`132`	`+ * ::: seealso`
	`133`	`+ * [method@Image.fwfft], [method@Image.cross_phase],`
`133`	`134`	`*`
`134`	`135`	`* Returns: 0 on success, -1 on error.`
`135`	`136`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -115,9 +115,11 @@ vips_spectrum_init(VipsSpectrum *spectrum)`
`115`	`115`	`* Make a displayable (ie. 8-bit unsigned int) power spectrum.`
`116`	`116`	`*`
`117`	`117`	`* If @in is non-complex, it is transformed to Fourier space. Then the`
`118`		`- * absolute value is passed through vips_scale() in log mode, and vips_wrap().`
	`118`	`+ * absolute value is passed through [method@Image.scale] in log mode, and`
	`119`	`+ * [method@Image.wrap].`
`119`	`120`	`*`
`120`		`- * See also: vips_fwfft(), vips_scale(), vips_wrap().`
	`121`	`+ * ::: seealso`
	`122`	`+ * [method@Image.fwfft], [method@Image.scale], [method@Image.wrap].`
`121`	`123`	`*`
`122`	`124`	`* Returns: 0 on success, -1 on error.`
`123`	`125`	`*/`