Skip to content

v3 documentation: readme module table and PropertyValueProtection.md are out of date #113

Description

@jorabin

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-kdb etc.); in v3 they are KeePassJava2.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).
  • example has an empty link and a JavaDoc badge, though it isn't published in v3.
  • basic is 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 is KdbxDatabase in v3, and to "the Jackson implementation"; other details need checking against the v3 code.

Activity

  1. jorabin commented on Oct 7, 2026

    @jorabin
    OwnerAuthor

    Also for 2.x, on master (to be merged to develop):

    • Readme module table: javadoc.io badges show the latest version of an artifactId, and database and KeePassJava2 are 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). The simple row linked to KeePassJava2-kdbx; example and test are marked as not published; the JavaDoc header cell is closed.
    • Javadoc links in the text: Database, Group and Entry link to the 2.2.6 Javadoc pages, and KdbxSerializer to its page in KeePassJava2-kdbx (the old links used javadoc.io's old URL format and the stream_3_1 package).

    On v3-master the same text links now point to the 3.1.0 pages (KdbxSerializer is in KeePassJava2.kdbx.io).

  2. jorabin commented on Oct 7, 2026

    @jorabin
    OwnerAuthor

    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.

  3. jorabin commented on Oct 7, 2026

    @jorabin
    OwnerAuthor

    Done on all four branches:

    • v3-master (merged to v3-develop): readme module table (654fb99), readme Javadoc links (d5de1f3), PropertyValueProtection.md (4140031)
    • master (merged to develop): readme module table and Javadoc links (2f3893b), typo (aec91b2)
    • javadoc.io: 3.0.0/3.1.0 and 2.2.5/2.2.6 Javadoc generated; GitHub's cached badge images purged

    Version naming and the KDBX read/write descriptions in the readmes continue in #114.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions