Skip to content

Commit 2f3893b

Browse files
jorabinclaude
jorabin
and
claude
committed
Fix the readme module table and Javadoc links for 2.x (#113)
javadoc.io badges show the latest version of an artifactId, which for database and KeePassJava2 is now 3.x, so those two get a static 2.2.6 badge linked to the 2.2.6 Javadoc; the 2.x-only artifacts use the current badge URL. Fix the simple row's link, mark example and test as not published, close the JavaDoc header cell, and point the Database, Group, Entry and KdbxSerializer links at the 2.2.6 Javadoc pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent ce7e7b7 commit 2f3893b

1 file changed

Lines changed: 17 additions & 19 deletions

File tree

‎readme.md‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -141,9 +141,9 @@ The Database has a root group and by following subgroups of the root group the t
141141
database.newGroup(groupToCopy);
142142

143143
The class Javadoc on Interface classes
144-
[Database](http://javadoc.io/page/org.linguafranca.pwdb/database/latest/org/linguafranca/pwdb/Database.html),
145-
[Group](http://javadoc.io/page/org.linguafranca.pwdb/database/latest/org/linguafranca/pwdb/Group.html) and
146-
[Entry](http://javadoc.io/page/org.linguafranca.pwdb/database/latest/org/linguafranca/pwdb/Entry.html) describe
144+
[Database](https://javadoc.io/doc/org.linguafranca.pwdb/database/2.2.6/org.linguafranca.pwdb.database/org/linguafranca/pwdb/Database.html),
145+
[Group](https://javadoc.io/doc/org.linguafranca.pwdb/database/2.2.6/org.linguafranca.pwdb.database/org/linguafranca/pwdb/Group.html) and
146+
[Entry](https://javadoc.io/doc/org.linguafranca.pwdb/database/2.2.6/org.linguafranca.pwdb.database/org/linguafranca/pwdb/Entry.html) describe
147147
how to use the methods of those classes to create and modify entries. These classes
148148
provide the basis of all implementations of the various database formats,
149149
initially KDB, KDBX 3.1 and KDBX 4 (KeePass 2) file formats, subsequently, potentially, others.
@@ -174,7 +174,7 @@ For the sake of
174174
clarification and my own satisfaction I have written about my understanding of
175175
KeePass formats in the following locations:
176176

177-
1. The Javadoc header to [KdbxSerializer](http://javadoc.io/page/org.linguafranca.pwdb/KeePassJava2-kdbx/latest/org/linguafranca/pwdb/kdbx/stream_3_1/KdbxSerializer.html) describes KDBX stream formatting.
177+
1. The Javadoc header to [KdbxSerializer](https://javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-kdbx/latest/org.linguafranca.pwdb.kdbx/org/linguafranca/pwdb/kdbx/KdbxSerializer.html) describes KDBX stream formatting.
178178
2. The XSD Schema [KDBX.4.xsd](KDBX.4.xsd) documents my understanding of the Keepass XML, and also my
179179
lack of understanding, in parts. While preparing release 2.2.3 I found [this XSD](https://keepass.info/help/download/KDBX_XML.xsd) at the
180180
KeePass site. I have not (so far) attempted to reconcile my documentation with it.
@@ -243,53 +243,51 @@ Each module corresponds to a Maven artifact. The GroupId is `org.linguafranca.pw
243243

244244
<table>
245245
<thead>
246-
<tr><th>Module</th><th>ArtifactId</th><th>JavaDoc<th>Description</th></tr>
246+
<tr><th>Module</th><th>ArtifactId</th><th>JavaDoc</th><th>Description</th></tr>
247247
</thead>
248248
<tbody>
249249

250250
<tr><td><a href="database">database</a></td><td>database</td>
251-
<td>
252-
<a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/database"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/database.svg" alt="Javadocs"></a>
253-
</td>
251+
<td><a href="https://javadoc.io/doc/org.linguafranca.pwdb/database/2.2.6"><img src="https://badgen.net/badge/javadoc/2.2.6/green" alt="Javadocs"></a></td>
254252
<td>Base definition of the Database APIs.</td></tr>
255-
<tr><td><a href="example">example</a></td><td>example</td>
256-
<td><a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/example"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/example.svg" alt="Javadocs"></a></td>
253+
<tr><td><a href="example">example</a></td><td>(not published)</td>
254+
<td>(not published)</td>
257255
<td>Worked examples of loading, saving, splicing etc. using the APIs</td></tr>
258256

259-
<tr><td><a href="test">test</a></td><td>test</td>
260-
<td><a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/test"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/test.svg" alt="Javadocs"></a></td>
257+
<tr><td><a href="test">test</a></td><td>(not published)</td>
258+
<td>(not published)</td>
261259
<td>Shared tests to assess the viability of the implementation.</td></tr>
262260

263261
<tr><td><a href="all">all</a></td><td><strong>KeePassJava2</strong></td>
264-
<td>(no JavaDoc)</td>
262+
<td><a href="https://javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2/2.2.6"><img src="https://badgen.net/badge/javadoc/2.2.6/green" alt="Javadocs"></a></td>
265263
<td>This is the main KeePassJava2 Maven dependency. Provides a route to all artifacts (other than test and examples) via transitive dependency.</td></tr>
266264

267265
<tr><td><a href="kdb">kdb</a></td><td>KeePassJava2-kdb</td>
268-
<td><a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-kdb"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/KeePassJava2-kdb.svg" alt="Javadocs"></a></td>
266+
<td><a href="https://javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-kdb"><img src="https://javadoc.io/badge2/org.linguafranca.pwdb/KeePassJava2-kdb/javadoc.svg" alt="Javadocs"></a></td>
269267
<td>An implementation of the Database APIs supporting KeePass KDB format.</td></tr>
270268

271269
<tr><td><a href="kdbx">kdbx</a></td><td>KeePassJava2-kdbx</td>
272-
<td><a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-kdbx"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/KeePassJava2-kdbx.svg" alt="Javadocs"></a></td>
270+
<td><a href="https://javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-kdbx"><img src="https://javadoc.io/badge2/org.linguafranca.pwdb/KeePassJava2-kdbx/javadoc.svg" alt="Javadocs"></a></td>
273271
<td>Provides support for KDBX streaming and security.</td></tr>
274272

275273

276274
<tr><td><a href="jackson">jackson</a></td><td>KeePassJava2-jackson</td>
277-
<td><a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-jackson"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/KeePassJava2-jackson.svg" alt="Javadocs"></a></td>
275+
<td><a href="https://javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-jackson"><img src="https://javadoc.io/badge2/org.linguafranca.pwdb/KeePassJava2-jackson/javadoc.svg" alt="Javadocs"></a></td>
278276
<td>A Jackson based implementation of KDBX. Intended to provide the main support going forward, replacing trhe
279277
modules below.</td></tr>
280278

281279
<tr style="background-color: gray;"><td><a href="simple">simple</a></td><td>KeePassJava2-simple</td>
282-
<td><a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-kdbx"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/KeePassJava2-kdbx.svg" alt="Javadocs"></a></td>
280+
<td><a href="https://javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-simple"><img src="https://javadoc.io/badge2/org.linguafranca.pwdb/KeePassJava2-simple/javadoc.svg" alt="Javadocs"></a></td>
283281
<td>A Simple XML Platform implementation of KDBX. Could be useful for Android.
284282
Simple cannot be used with Java versions 17 and up.</td></tr>
285283

286284
<tr style="background-color: gray;"><td><a href="jaxb">jaxb</a></td><td>KeePassJava2-jaxb</td>
287-
<td><a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-jaxb"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/KeePassJava2-jaxb.svg" alt="Javadocs"></a></td>
285+
<td><a href="https://javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-jaxb"><img src="https://javadoc.io/badge2/org.linguafranca.pwdb/KeePassJava2-jaxb/javadoc.svg" alt="Javadocs"></a></td>
288286
<td>A JAXB implementation of KDBX. Probably not useful for Android. The generated class
289287
bindings might be useful for building other interfaces.</td></tr>
290288

291289
<tr style="background-color: gray;"><td><a href="dom">dom</a></td><td>KeePassJava2-dom</td>
292-
<td><a href="https://www.javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-dom"><img src="https://www.javadoc.io/badge/org.linguafranca.pwdb/KeePassJava2-dom.svg" alt="Javadocs"></a></td>
290+
<td><a href="https://javadoc.io/doc/org.linguafranca.pwdb/KeePassJava2-dom"><img src="https://javadoc.io/badge2/org.linguafranca.pwdb/KeePassJava2-dom/javadoc.svg" alt="Javadocs"></a></td>
293291
<td>A DOM based implementation of KDBX. Being DOM based it is rather slow, but
294292
messes less with existing content than the other implementations. Known to work on Android.</td></tr>
295293

0 commit comments

Comments
 (0)