Skip to content

Commit 261d5f6

Browse files
committed
Use a definition list rather than a table in UrlTemplates javadoc
The <table summary="..."> form is obsolete: the summary attribute was removed in HTML5, and javadoc has generated HTML5 since JDK 15, so doclint rejects it whenever it is switched on. The build sets -Xdoclint:none so this never broke CI, but it would surface in the release profile and the attribute does nothing for accessibility any more. A definition list suits a list of placeholders and their meanings better than a two-column table in any case.
1 parent 3fb44cf commit 261d5f6

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

  • biojava-structure/src/main/java/org/biojava/nbio/structure/io/density

biojava-structure/src/main/java/org/biojava/nbio/structure/io/density/UrlTemplates.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,16 @@
2727
* templates.
2828
* <p>
2929
* The recognised placeholders are:
30-
* <table summary="placeholders">
31-
* <tr><td><code>{pdbid}</code></td><td>the PDB identifier as given</td></tr>
32-
* <tr><td><code>{pdbid_lc}</code></td><td>the PDB identifier in lower case</td></tr>
33-
* <tr><td><code>{pdbid_uc}</code></td><td>the PDB identifier in upper case</td></tr>
34-
* <tr><td><code>{mid}</code></td><td>the two-character divided-archive directory,
35-
* e.g. <code>cb</code> for <code>1cbs</code></td></tr>
36-
* <tr><td><code>{emdb_id}</code></td><td>the EMDB identifier, e.g. <code>EMD-0262</code></td></tr>
37-
* <tr><td><code>{emdb_num}</code></td><td>the EMDB number alone, e.g. <code>0262</code></td></tr>
38-
* <tr><td><code>{detail}</code></td><td>the density-server detail level</td></tr>
39-
* </table>
30+
* <dl>
31+
* <dt><code>{pdbid}</code></dt><dd>the PDB identifier as given</dd>
32+
* <dt><code>{pdbid_lc}</code></dt><dd>the PDB identifier in lower case</dd>
33+
* <dt><code>{pdbid_uc}</code></dt><dd>the PDB identifier in upper case</dd>
34+
* <dt><code>{mid}</code></dt><dd>the two-character divided-archive directory,
35+
* e.g. <code>cb</code> for <code>1cbs</code></dd>
36+
* <dt><code>{emdb_id}</code></dt><dd>the EMDB identifier, e.g. <code>EMD-0262</code></dd>
37+
* <dt><code>{emdb_num}</code></dt><dd>the EMDB number alone, e.g. <code>0262</code></dd>
38+
* <dt><code>{detail}</code></dt><dd>the density-server detail level</dd>
39+
* </dl>
4040
* A placeholder with no supplied value is left in place rather than replaced by
4141
* an empty string, so that a misconfigured template produces an obviously wrong
4242
* URL instead of a subtly wrong one.

0 commit comments

Comments
 (0)