Repository navigation
v3 documentation: readme module table and PropertyValueProtection.md are out of date #113
Description
Documentation fixes for v3, made on v3-master and merged to v3-develop.
Readme, Module Structure table
- The ArtifactId column shows the 2.x names (
KeePassJava2-kdbetc.); in v3 they areKeePassJava2.kdb,KeePassJava2.kdbx.io,KeePassJava2.kdbx.database. - The JavaDoc badges are broken: they use the old javadoc.io badge URL, which returns 404 for the v3 artifacts, and some links point to the wrong artifacts (
KeePassJava2-kdbx,KeePassJava2-jackson). examplehas an empty link and a JavaDoc badge, though it isn't published in v3.basicis described as a database implementation with a JavaDoc badge; it is an experimental prototype and has never been published.
PropertyValueProtection.md
- Refers to
JacksonDatabase, which isKdbxDatabasein v3, and to "the Jackson implementation"; other details need checking against the v3 code.
Activity
Fix the readme module table: v3 artifactIds, working Javadoc badges, …
Fix the readme's Javadoc links to Database, Group, Entry and KdbxSeri…
jorabin commentedon Oct 7, 2026
Also for 2.x, on
master(to be merged todevelop):databaseandKeePassJava2are shared with v3, so on the 2.x readme they showed 3.x. They now have a static 2.2.6 badge linked to the 2.2.6 Javadoc. The 2.x-only artifacts (KeePassJava2-kdb,-kdbx,-jackson,-simple,-jaxb,-dom) use the current badge URL and show 2.2.6 (2.2.5 and 2.2.6 have been generated on javadoc.io). Thesimplerow linked toKeePassJava2-kdbx;exampleandtestare marked as not published; the JavaDoc header cell is closed.Database,GroupandEntrylink to the 2.2.6 Javadoc pages, andKdbxSerializerto its page inKeePassJava2-kdbx(the old links used javadoc.io's old URL format and thestream_3_1package).On
v3-masterthe same text links now point to the 3.1.0 pages (KdbxSerializeris inKeePassJava2.kdbx.io).Fix the readme module table and Javadoc links for 2.x (#113)
jorabin commentedon Oct 7, 2026
The readme's descriptions of which KDBX versions are read and written, and the mixed use of version numbers (KeePass 1.x/2.x, KDB/KDBX 3.1/4/4.1, KeePassJava2 2.x/3.x, e.g. "the KeePass V2 KDB format"), are left for #114, since they depend on fixing how KDBX 4.1 is written.
Fix a typo in the readme module table (#113)
Bring PropertyValueProtection.md up to date for 3.x (#113)
jorabin commentedon Oct 7, 2026
Done on all four branches:
v3-master(merged tov3-develop): readme module table (654fb99), readme Javadoc links (d5de1f3), PropertyValueProtection.md (4140031)master(merged todevelop): readme module table and Javadoc links (2f3893b), typo (aec91b2)Version naming and the KDBX read/write descriptions in the readmes continue in #114.