Skip to content

Commit fb667f3

Browse files
authored
Use GIR to improve VImage docs (#87)
1 parent 00a383b commit fb667f3

File tree

6 files changed

+4143
-364
lines changed

6 files changed

+4143
-364
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ repositories {
2121
}
2222

2323
dependencies {
24-
implementation("app.photofox.vips-ffm:vips-ffm-core:0.5.12")
24+
implementation("app.photofox.vips-ffm:vips-ffm-core:0.5.13")
2525
}
2626
```
2727
When running your project you must add `--enable-native-access=ALL-UNNAMED` to your JVM runtime arguments. If you
@@ -40,9 +40,10 @@ libvips versions, assuming there haven't been major changes.
4040
4141
All libvips operations are exposed via helper classes, like `VImage`. You must provide an [Arena][1] to operations like
4242
`VImage.newFromFile`, which constrains the lifetime of objects generated during usage. You can get an appropriate arena
43-
by using `Vips.run` as shown in the [sample](#thumbnail-sample) below. These helper objects expose their raw pointers
44-
as a last resort via functions like `VTarget.getUnsafeStructAddress` - if you need to use these raw pointers and can't
45-
find an alternative, please file a GitHub Issue.
43+
by using `Vips.run` as shown in the [sample](#thumbnail-sample) below. `VImage` has extensive Javadocs included, which
44+
are automatically generated from the same source that the libvips website uses, for ease of use. These helper objects
45+
expose their raw pointers as a last resort via functions like `VTarget.getUnsafeStructAddress` - if you need to use
46+
these raw pointers and can't find an alternative, please file a GitHub Issue.
4647

4748
Helper enums are generated for the version of libvips shown above. If you need to use an enum from another version,
4849
which isn't present in `vips-ffm`, you can use `VipsOption.Enum(rawValue)` or `VEnum.Raw(rawValue)`.

0 commit comments

Comments
 (0)