Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs for 1.1 release #105

Merged
merged 1 commit into from
Oct 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ jobs:
with:
gradle-version: 8.10.1

- name: Regenerate docs and check for changes
run: bash verify_docs_up_to_date.sh

- name: Run checks
run: ./gradlew build check shadowJar

Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ build

.idea

jextract*
jextract.tar.gz
jextract-*
logo*
includes.txt
includes_filtered.txt
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ repositories {
}

dependencies {
implementation("app.photofox.vips-ffm:vips-ffm-core:1.1.0")
implementation("app.photofox.vips-ffm:vips-ffm-core:1.1.1")
}
```
When running your project you must add `--enable-native-access=ALL-UNNAMED` to your JVM runtime arguments. If you
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
* <p>Automatically generated bindings from the jextract tool</p>
*
* <p><b>API compatibility is not guaranteed across minor versions for classes in this package - things may change!</b></p>
*/
package app.photofox.vipsffm.jextract;
2 changes: 1 addition & 1 deletion docs/allpackages-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</div>
<div class="col-first even-row-color"><a href="app.photofox.vipsffm/app/photofox/vipsffm/jextract/package-summary.html">app.photofox.vipsffm.jextract</a></div>
<div class="col-last even-row-color">
<div class="block">Automatically generated bindings using the jextract tool</div>
<div class="block">Automatically generated bindings from the jextract tool</div>
</div>
</div>
</main>
Expand Down
31 changes: 30 additions & 1 deletion docs/app.photofox.vipsffm/app/photofox/vipsffm/VBlob.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#newFromBytes(java.lang.foreign.Arena,byte%5B%5D)" tabindex="0">newFromBytes(Arena, byte[])</a></li>
<li><a href="#getUnsafeAddress()" tabindex="0">getUnsafeAddress()</a></li>
<li><a href="#getUnsafeStructAddress()" tabindex="0">getUnsafeStructAddress()</a></li>
<li><a href="#getUnsafeDataAddress()" tabindex="0">getUnsafeDataAddress()</a></li>
Expand Down Expand Up @@ -99,7 +100,7 @@ <h1 title="Class VBlob" class="title">Class VBlob</h1>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
Expand Down Expand Up @@ -153,6 +154,14 @@ <h2>Method Summary</h2>
Usage of the memory address is strongly discouraged, but it is available if some functionality is missing and you
need to use it with <a href="VipsHelper.html" title="class in app.photofox.vipsffm"><code>VipsHelper</code></a></div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="VBlob.html" title="class in app.photofox.vipsffm">VBlob</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#newFromBytes(java.lang.foreign.Arena,byte%5B%5D)" class="member-name-link">newFromBytes</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/foreign/Arena.html" title="class or interface in java.lang.foreign" class="external-link">Arena</a>&nbsp;arena,
byte[]&nbsp;bytes)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Creates a new VBlob from a fixed array of bytes
This must copy the data - it's generally more efficient to use <a href="VImage.html#newFromFile(java.lang.foreign.Arena,java.lang.String,app.photofox.vipsffm.VipsOption...)"><code>VImage.newFromFile(Arena, String, VipsOption...)</code></a>,
<a href="VImage.html#newFromSource(java.lang.foreign.Arena,app.photofox.vipsffm.VSource,java.lang.String,app.photofox.vipsffm.VipsOption...)"><code>VImage.newFromSource(Arena, VSource, String, VipsOption...)</code></a>, and friends</div>
</div>
</div>
</div>
</div>
Expand All @@ -171,6 +180,26 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="newFromBytes(java.lang.foreign.Arena,byte[])">
<h3>newFromBytes</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="VBlob.html" title="class in app.photofox.vipsffm">VBlob</a></span>&nbsp;<span class="element-name">newFromBytes</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/foreign/Arena.html" title="class or interface in java.lang.foreign" class="external-link">Arena</a>&nbsp;arena,
byte[]&nbsp;bytes)</span>
throws <span class="exceptions"><a href="VipsError.html" title="class in app.photofox.vipsffm">VipsError</a></span></div>
<div class="block">Creates a new VBlob from a fixed array of bytes
This must copy the data - it's generally more efficient to use <a href="VImage.html#newFromFile(java.lang.foreign.Arena,java.lang.String,app.photofox.vipsffm.VipsOption...)"><code>VImage.newFromFile(Arena, String, VipsOption...)</code></a>,
<a href="VImage.html#newFromSource(java.lang.foreign.Arena,app.photofox.vipsffm.VSource,java.lang.String,app.photofox.vipsffm.VipsOption...)"><code>VImage.newFromSource(Arena, VSource, String, VipsOption...)</code></a>, and friends</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>arena</code> - An arena constraining the lifetime of this blob</dd>
<dd><code>bytes</code> - The bytes to wrap</dd>
<dt>Throws:</dt>
<dd><code><a href="VipsError.html" title="class in app.photofox.vipsffm">VipsError</a></code></dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getUnsafeAddress()">
<h3>getUnsafeAddress</h3>
<div class="horizontal-scroll">
Expand Down
Loading