Skip to content

Commit 73f5111

Browse files
lopcodelopcode
authored
Fix a few rogue old-style comments (#152)
1 parent 505a28a commit 73f5111

24 files changed

+1983
-2523
lines changed

‎core/src/main/java/app/photofox/vipsffm/VipsHelper.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77
import java.util.List;
88

99
/// Generated helpers to wrap [VipsRaw] JExtract definitions
10-
/// * Validation of input pointers is performed, but prefer usage of [VImage] and friends which do not expose raw pointers
11-
/// * **Nothing in this class is guaranteed to stay the same across minor versions - use at your own risk!**
10+
///
11+
/// Validation of input pointers is performed, but prefer usage of [VImage] and friends which do not expose raw pointers
12+
///
13+
/// **Nothing in this class is guaranteed to stay the same across minor versions - use at your own risk!**
1214
public final class VipsHelper {
1315
public static void init(Arena arena, boolean allowUntrusted) {
1416
var nameCString = arena.allocateFrom("vips-ffm");

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/VImage.html‎

Lines changed: 1914 additions & 2414 deletions
Large diffs are not rendered by default.

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/VipsHelper.html‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,8 @@ <h1 title="Class VipsHelper" class="title">Class VipsHelper</h1>
233233
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">VipsHelper</span>
234234
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
235235
<div class="block"><p>Generated helpers to wrap <a href="jextract/VipsRaw.html" title="class in app.photofox.vipsffm.jextract"><code>VipsRaw</code></a> JExtract definitions</p>
236-
<ul>
237-
<li>Validation of input pointers is performed, but prefer usage of <a href="VImage.html" title="class in app.photofox.vipsffm"><code>VImage</code></a> and friends which do not expose raw pointers</li>
238-
<li><strong>Nothing in this class is guaranteed to stay the same across minor versions - use at your own risk!</strong></li>
239-
</ul>
236+
<p>Validation of input pointers is performed, but prefer usage of <a href="VImage.html" title="class in app.photofox.vipsffm"><code>VImage</code></a> and friends which do not expose raw pointers</p>
237+
<p><strong>Nothing in this class is guaranteed to stay the same across minor versions - use at your own risk!</strong></p>
240238
</div>
241239
</div>
242240
</section>

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/enums/VipsAccess.html‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,9 @@ <h1 title="Enum Class VipsAccess" class="title">Enum Class VipsAccess</h1>
112112
implements <a href="../VNamedEnum.html" title="interface in app.photofox.vipsffm">VNamedEnum</a></span></div>
113113
<div class="block"><p>The type of access an operation has to supply. See <a href="../VImage.html#tilecache(app.photofox.vipsffm.VipsOption...)"><code>VImage.tilecache(app.photofox.vipsffm.VipsOption...)</code></a>
114114
and <code>Foreign</code>.</p>
115-
<ul>
116-
<li><a href="#ACCESS_RANDOM"><code>ACCESS_RANDOM</code></a> means requests can come in any order.</li>
117-
<li><a href="#ACCESS_SEQUENTIAL"><code>ACCESS_SEQUENTIAL</code></a> means requests will be top-to-bottom, but with some
118-
amount of buffering behind the read point for small non-local accesses.</li>
119-
</ul>
115+
<p><a href="#ACCESS_RANDOM"><code>ACCESS_RANDOM</code></a> means requests can come in any order.</p>
116+
<p><a href="#ACCESS_SEQUENTIAL"><code>ACCESS_SEQUENTIAL</code></a> means requests will be top-to-bottom, but with some
117+
amount of buffering behind the read point for small non-local accesses.</p>
120118
</div>
121119
</div>
122120
</section>

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/enums/VipsAlign.html‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,9 @@ <h1 title="Enum Class VipsAlign" class="title">Enum Class VipsAlign</h1>
111111
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="VipsAlign.html" title="enum class in app.photofox.vipsffm.enums">VipsAlign</a>&gt;
112112
implements <a href="../VNamedEnum.html" title="interface in app.photofox.vipsffm">VNamedEnum</a></span></div>
113113
<div class="block"><p>See <a href="../VImage.html#join(app.photofox.vipsffm.VImage,app.photofox.vipsffm.enums.VipsDirection,app.photofox.vipsffm.VipsOption...)"><code>VImage.join(app.photofox.vipsffm.VImage, app.photofox.vipsffm.enums.VipsDirection, app.photofox.vipsffm.VipsOption...)</code></a> and so on.</p>
114-
<ul>
115-
<li>Operations like <a href="../VImage.html#join(app.photofox.vipsffm.VImage,app.photofox.vipsffm.enums.VipsDirection,app.photofox.vipsffm.VipsOption...)"><code>VImage.join(app.photofox.vipsffm.VImage, app.photofox.vipsffm.enums.VipsDirection, app.photofox.vipsffm.VipsOption...)</code></a> need to be told whether to align images on the
116-
low or high coordinate edge, or centre.</li>
117-
<li>See also: <a href="../VImage.html#join(app.photofox.vipsffm.VImage,app.photofox.vipsffm.enums.VipsDirection,app.photofox.vipsffm.VipsOption...)"><code>VImage.join(app.photofox.vipsffm.VImage, app.photofox.vipsffm.enums.VipsDirection, app.photofox.vipsffm.VipsOption...)</code></a></li>
118-
</ul>
114+
<p>Operations like <a href="../VImage.html#join(app.photofox.vipsffm.VImage,app.photofox.vipsffm.enums.VipsDirection,app.photofox.vipsffm.VipsOption...)"><code>VImage.join(app.photofox.vipsffm.VImage, app.photofox.vipsffm.enums.VipsDirection, app.photofox.vipsffm.VipsOption...)</code></a> need to be told whether to align images on the
115+
low or high coordinate edge, or centre.</p>
116+
<p>See also: <a href="../VImage.html#join(app.photofox.vipsffm.VImage,app.photofox.vipsffm.enums.VipsDirection,app.photofox.vipsffm.VipsOption...)"><code>VImage.join(app.photofox.vipsffm.VImage, app.photofox.vipsffm.enums.VipsDirection, app.photofox.vipsffm.VipsOption...)</code></a></p>
119117
</div>
120118
</div>
121119
</section>

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/enums/VipsAngle.html‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,8 @@ <h1 title="Enum Class VipsAngle" class="title">Enum Class VipsAngle</h1>
112112
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="VipsAngle.html" title="enum class in app.photofox.vipsffm.enums">VipsAngle</a>&gt;
113113
implements <a href="../VNamedEnum.html" title="interface in app.photofox.vipsffm">VNamedEnum</a></span></div>
114114
<div class="block"><p>See <a href="../VImage.html#rot(app.photofox.vipsffm.enums.VipsAngle,app.photofox.vipsffm.VipsOption...)"><code>VImage.rot(app.photofox.vipsffm.enums.VipsAngle, app.photofox.vipsffm.VipsOption...)</code></a> and so on.</p>
115-
<ul>
116-
<li>Fixed rotate angles.</li>
117-
<li>See also: <a href="../VImage.html#rot(app.photofox.vipsffm.enums.VipsAngle,app.photofox.vipsffm.VipsOption...)"><code>VImage.rot(app.photofox.vipsffm.enums.VipsAngle, app.photofox.vipsffm.VipsOption...)</code></a></li>
118-
</ul>
115+
<p>Fixed rotate angles.</p>
116+
<p>See also: <a href="../VImage.html#rot(app.photofox.vipsffm.enums.VipsAngle,app.photofox.vipsffm.VipsOption...)"><code>VImage.rot(app.photofox.vipsffm.enums.VipsAngle, app.photofox.vipsffm.VipsOption...)</code></a></p>
119117
</div>
120118
</div>
121119
</section>

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/enums/VipsAngle45.html‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,8 @@ <h1 title="Enum Class VipsAngle45" class="title">Enum Class VipsAngle45</h1>
116116
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="VipsAngle45.html" title="enum class in app.photofox.vipsffm.enums">VipsAngle45</a>&gt;
117117
implements <a href="../VNamedEnum.html" title="interface in app.photofox.vipsffm">VNamedEnum</a></span></div>
118118
<div class="block"><p>See <a href="../VImage.html#rot45(app.photofox.vipsffm.VipsOption...)"><code>VImage.rot45(app.photofox.vipsffm.VipsOption...)</code></a> and so on.</p>
119-
<ul>
120-
<li>Fixed rotate angles.</li>
121-
<li>See also: <a href="../VImage.html#rot45(app.photofox.vipsffm.VipsOption...)"><code>VImage.rot45(app.photofox.vipsffm.VipsOption...)</code></a></li>
122-
</ul>
119+
<p>Fixed rotate angles.</p>
120+
<p>See also: <a href="../VImage.html#rot45(app.photofox.vipsffm.VipsOption...)"><code>VImage.rot45(app.photofox.vipsffm.VipsOption...)</code></a></p>
123121
</div>
124122
</div>
125123
</section>

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/enums/VipsBandFormat.html‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,8 @@ <h1 title="Enum Class VipsBandFormat" class="title">Enum Class VipsBandFormat</h
119119
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="VipsBandFormat.html" title="enum class in app.photofox.vipsffm.enums">VipsBandFormat</a>&gt;
120120
implements <a href="../VNamedEnum.html" title="interface in app.photofox.vipsffm">VNamedEnum</a></span></div>
121121
<div class="block"><p>The format used for each band element.</p>
122-
<ul>
123-
<li>Each corresponds to a native C type for the current machine. For example,
124-
<a href="#FORMAT_USHORT"><code>FORMAT_USHORT</code></a> is <code>unsigned short</code>.</li>
125-
</ul>
122+
<p>Each corresponds to a native C type for the current machine. For example,
123+
<a href="#FORMAT_USHORT"><code>FORMAT_USHORT</code></a> is <code>unsigned short</code>.</p>
126124
</div>
127125
</div>
128126
</section>

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/enums/VipsBlendMode.html‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,9 @@ <h1 title="Enum Class VipsBlendMode" class="title">Enum Class VipsBlendMode</h1>
134134
implements <a href="../VNamedEnum.html" title="interface in app.photofox.vipsffm">VNamedEnum</a></span></div>
135135
<div class="block"><p>The various Porter-Duff and PDF blend modes. See <a href="../VImage.html#composite(java.lang.foreign.Arena,java.util.List,java.util.List,app.photofox.vipsffm.VipsOption...)"><code>VImage.composite(java.lang.foreign.Arena, java.util.List&lt;app.photofox.vipsffm.VImage&gt;, java.util.List&lt;java.lang.Integer&gt;, app.photofox.vipsffm.VipsOption...)</code></a>,
136136
for example.</p>
137-
<ul>
138-
<li>The Cairo docs have <a href="https://www.cairographics.org/operators">a nice explanation of all the blend
139-
modes</a>.</li>
140-
<li>The non-separable modes are not implemented.</li>
141-
</ul>
137+
<p>The Cairo docs have <a href="https://www.cairographics.org/operators">a nice explanation of all the blend
138+
modes</a>.</p>
139+
<p>The non-separable modes are not implemented.</p>
142140
</div>
143141
</div>
144142
</section>

‎docs/app.photofox.vipsffm/app/photofox/vipsffm/enums/VipsCoding.html‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,11 @@ <h1 title="Enum Class VipsCoding" class="title">Enum Class VipsCoding</h1>
112112
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="VipsCoding.html" title="enum class in app.photofox.vipsffm.enums">VipsCoding</a>&gt;
113113
implements <a href="../VNamedEnum.html" title="interface in app.photofox.vipsffm">VNamedEnum</a></span></div>
114114
<div class="block"><p>How pixels are coded.</p>
115-
<ul>
116-
<li>Normally, pixels are uncoded and can be manipulated as you would expect.
115+
<p>Normally, pixels are uncoded and can be manipulated as you would expect.
117116
However some file formats code pixels for compression, and sometimes it's
118-
useful to be able to manipulate images in the coded format.</li>
119-
<li>The gaps in the numbering are historical and must be maintained. Allocate
120-
new numbers from the end.</li>
121-
</ul>
117+
useful to be able to manipulate images in the coded format.</p>
118+
<p>The gaps in the numbering are historical and must be maintained. Allocate
119+
new numbers from the end.</p>
122120
</div>
123121
</div>
124122
</section>

0 commit comments

Comments
 (0)