Search code examples
javamavenliterate-programmingdoccomarginalia

Marginalia / Docco / etc for Java Maven projects?

Is it possible to run Marginalia on a Java (multi-module) project which uses Maven?

Or is there any other alternative that's similar to Marginalia or Docco that can do this?

What's important to me is to be able to add it as a dependency from some public Maven repository and to use it straight away, without installing any additional stuff like Node.js for Docco for example - which is reasonable since it's a Java project.

Solution

  • I've tried several options:

    • Marginalia with the Zi plugin;
    • Jocco (though it is not published on any Maven repo);
    • and then, I found atlasssian-docco!

    I'll have to revise my comments formatting to fit the guide, but I think this Maven plugin will do the job. Any thoughts?