search

joffrey-bion / livedoc

A not-so-annotation-based documentation generator for REST and websocket services
MIT License
4 stars 2 forks source link

Support Javadoc @link/@code tags #88

Closed joffrey-bion closed 6 years ago

joffrey-bion commented 6 years ago

These tags are quite common in Javadoc descriptions, and should not be displayed as {@link } or {@code } inside descriptions, but rather as HTML <code> blocks.

Furthermore, a very nice thing would be to support actual links when {@link } is used on a documented type, but this implies having some sort of complex representation for descriptions rather than strings, which would add some kind of mapping from text to type IDs for instance. This depends on the information is provided by the runtime javadoc library.

joffrey-bion commented 6 years ago

Issue created and pull request made on therapi-runtime-javadoc to split the description into multiple parts: https://github.com/dnault/therapi-runtime-javadoc/issues/17 https://github.com/dnault/therapi-runtime-javadoc/pull/18 That PR should make this change possible.