Commit 2e9280b

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 2e9280bCopy full SHA for 2e9280b

File tree

4 files changed

+13

-62

lines changed

CHANGELOG.md
examples
- generate_phpdoc.py
src
- DemandStyle.php
- ImageAutodoc.php

4 files changed

+13

-62

lines changed

`‎CHANGELOG.md`

Lines changed: 3 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -4,6 +4,9 @@ All notable changes to `php-vips` will be documented in this file.
`4`	`4`
`5`	`5`	`## master`
`6`	`6`
	`7`	+- suppress autodoc of `composite` and `DemandStyle` [jcupitt]
	`8`	`+- update docs for 8.17 [jcupitt]`
	`9`	`+`
`7`	`10`	`## 2.5.0 - 2025年04月04日`
`8`	`11`
`9`	`12`	`- add addLibraryPath() to let users set their libvips location [kleisauke]`

`‎examples/generate_phpdoc.py`

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -225,6 +225,7 @@ def add_nickname(gtype, a, b):`
`225`	`225`
`226`	`226`	`# these have hand-written methods, don't autodoc them`
`227`	`227`	`no_generate = [`
	`228`	`+ 'composite',`
`228`	`229`	`'bandjoin',`
`229`	`230`	`'bandrank',`
`230`	`231`	`'ifthenelse',`
`@@ -287,6 +288,10 @@ def add_enum(gtype, a, b):`
`287`	`288`
`288`	`289`	`type_map(type_from_name('GEnum'), add_enum)`
`289`	`290`
	`291`	`+ # Filter internal enums`
	`292`	`+ blacklist = ['VipsDemandStyle']`
	`293`	`+ all_enums = [name for name in all_enums if name not in blacklist]`
	`294`	`+`
`290`	`295`	`for name in all_enums:`
`291`	`296`	`gtype = type_from_name(name)`
`292`	`297`	`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 number	Diff line number	Diff line change
`@@ -147,8 +147,6 @@`
`147`	`147`	`* @method Image complexget(string $get, array $options = []) Get a component from a complex image.`
`148`	`148`	`* @see OperationComplexget for possible values for $get`
`149`	`149`	`* @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`
`152`	`150`	`* @method Image composite2(Image $overlay, string $mode, array $options = []) Blend a pair of images with a blend mode.`
`153`	`151`	`* @see BlendMode for possible values for $mode`
`154`	`152`	`* @throws Exception`
`@@ -382,9 +380,9 @@`
`382`	`380`	`* @throws Exception`
`383`	`381`	`* @method static Image logmat(float $sigma, float $min_ampl, array $options = []) Make a Laplacian of Gaussian image.`
`384`	`382`	`* @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.`
`386`	`384`	`* @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.`
`388`	`386`	`* @throws Exception`
`389`	`387`	`* @method void magicksave(string $filename, array $options = []) Save file with ImageMagick.`
`390`	`388`	`* @throws Exception`
`@@ -503,7 +501,9 @@`
`503`	`501`	`* @throws Exception`
`504`	`502`	`* @method static Image ppmload(string $filename, array $options = []) Load ppm from file.`
`505`	`503`	`* @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.`
`507`	`507`	`* @throws Exception`
`508`	`508`	`* @method void ppmsave(string $filename, array $options = []) Save image to ppm file.`
`509`	`509`	`* @throws Exception`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 2e9280b

File tree

4 files changed

4 files changed

`‎CHANGELOG.md`

`‎examples/generate_phpdoc.py`

`‎src/DemandStyle.php`

`‎src/ImageAutodoc.php`

0 commit comments