Skip to content

Commit 2e9280b

Browse files
committed
small autodocs cleanup, regen for 8.17
Don't make autodoc wrappers for `composite` and `DemandStyle`, regen for 8.17.
1 parent 09f059c commit 2e9280b

File tree

4 files changed

+13
-62
lines changed

4 files changed

+13
-62
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ All notable changes to `php-vips` will be documented in this file.
44

55
## master
66

7+
- suppress autodoc of `composite` and `DemandStyle` [jcupitt]
8+
- update docs for 8.17 [jcupitt]
9+
710
## 2.5.0 - 2025-04-04
811

912
- add addLibraryPath() to let users set their libvips location [kleisauke]

examples/generate_phpdoc.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,7 @@ def add_nickname(gtype, a, b):
225225

226226
# these have hand-written methods, don't autodoc them
227227
no_generate = [
228+
'composite',
228229
'bandjoin',
229230
'bandrank',
230231
'ifthenelse',
@@ -287,6 +288,10 @@ def add_enum(gtype, a, b):
287288

288289
type_map(type_from_name('GEnum'), add_enum)
289290

291+
# Filter internal enums
292+
blacklist = ['VipsDemandStyle']
293+
all_enums = [name for name in all_enums if name not in blacklist]
294+
290295
for name in all_enums:
291296
gtype = type_from_name(name)
292297
php_name = remove_prefix(name)

src/DemandStyle.php

Lines changed: 0 additions & 57 deletions
This file was deleted.

src/ImageAutodoc.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,6 @@
147147
* @method Image complexget(string $get, array $options = []) Get a component from a complex image.
148148
* @see OperationComplexget for possible values for $get
149149
* @throws Exception
150-
* @method static Image composite(Image[]|Image $in, integer[]|integer $mode, array $options = []) Blend an array of images with an array of blend modes.
151-
* @throws Exception
152150
* @method Image composite2(Image $overlay, string $mode, array $options = []) Blend a pair of images with a blend mode.
153151
* @see BlendMode for possible values for $mode
154152
* @throws Exception
@@ -382,9 +380,9 @@
382380
* @throws Exception
383381
* @method static Image logmat(float $sigma, float $min_ampl, array $options = []) Make a Laplacian of Gaussian image.
384382
* @throws Exception
385-
* @method static Image magickload(string $filename, array $options = []) Load file with ImageMagick.
383+
* @method static Image magickload(string $filename, array $options = []) Load file with ImageMagick7.
386384
* @throws Exception
387-
* @method static Image magickload_buffer(string $buffer, array $options = []) Load buffer with ImageMagick.
385+
* @method static Image magickload_buffer(string $buffer, array $options = []) Load buffer with ImageMagick7.
388386
* @throws Exception
389387
* @method void magicksave(string $filename, array $options = []) Save file with ImageMagick.
390388
* @throws Exception
@@ -503,7 +501,9 @@
503501
* @throws Exception
504502
* @method static Image ppmload(string $filename, array $options = []) Load ppm from file.
505503
* @throws Exception
506-
* @method static Image ppmload_source(Source $source, array $options = []) Load ppm base class.
504+
* @method static Image ppmload_buffer(string $buffer, array $options = []) Load ppm from buffer.
505+
* @throws Exception
506+
* @method static Image ppmload_source(Source $source, array $options = []) Load ppm from source.
507507
* @throws Exception
508508
* @method void ppmsave(string $filename, array $options = []) Save image to ppm file.
509509
* @throws Exception

0 commit comments

Comments
 (0)