Monday, 15 August 2011

java - Generate API docs with Javadoc -


I am writing Javadox for a project, on which I am working, and @link each endpoint is linked to linking to Javadock for each method.

Ideally, I want to do something like this:

  POST / API / resource call {@link resource # getAll () resource @ getAll} received / api / Resources / {id} call {@link resource # getById (int) resource # getById}   

I am open to any solutions that are similar.

There is a feature in Maven that gives you the HTML markup to src / main / javadoc / overview. Html and it will process all the tags and write the output on the main Javadoc page.

This works very well when you use MarketDown Overview.html Page

No comments:

Post a Comment