jacamo-lang / jacamo-rest

REST API for JaCaMo (draft)
7 stars 5 forks source link

Unify command manuals (annotations) and javadocs #20

Open cleberjamaral opened 5 years ago

cleberjamaral commented 5 years ago

The manuals are written using java annotations, however the docs of JaCaMo APIs are written using javadocs bringing redundancy. The problem is that eclipse takes docs (to show on hints, for example) from javadocs as well as javadocs generation triggered by gradle. In the other hand, the online application cannot read the javadocs, it is reading java annotations. We need a way to somehow unify it.

cleberjamaral commented 5 years ago

Some links to check: https://github.com/paul-hammant/qdox https://stackoverflow.com/questions/2604424/how-can-i-add-a-default-header-to-my-source-files-automatically-in-eclipse https://www.javatips.net/api/com.thoughtworks.qdox.model.javaclass https://dzone.com/articles/generate-java-code-documentation-with-qdox-ejs-nashorn-and-asciidoctor