adr / e-adr Goto Github PK

View Code? Open in Web Editor NEW

25.0 25.0 7.0 1.09 MB

Architectural Decisions Records embedded in Java code

Home Page: https://adr.github.io/e-adr/

License: Eclipse Public License 2.0

Java 100.00%

e-adr's People

Contributors

Stargazers

Watchers

Forkers

schubmat ungerts ravi-algoguru adr-manager-anonymous omarhammami1992 kotenev vsujeesh

e-adr's Issues

Feature apidoc as related work

http://apidocjs.com/

How to generate adr files from code?

Hi,

i am trying to generate the ADR .md files from the code.
I have added @MADR and @ADR annotations in my code, but i don't understand how to generate the corresponding ADR files?

Consume external ADR files

This is an interesting idea, so kudos!

I indeed like the idea of the ADR linking annotation and having the ADR available in JavaDocs for developers browsing the code.

Would it be useful for the tool to consumer the ADR from an external markdown file (of whichever ADR format) and resolve the links when building JavaDoc?

This allows a single source of ADR (the markdown file) and does not need the ADR annotation (which feels awkward and bothersome).

An IDE plugin could even resolve links into ephemeral JavaDoc while the developer is browsing the code.

Cheers for advancing the ADR idea with this tool and your other works!