Generated API documentation is great but that doesn't mean you get everything for free. You have to give the generator something to work with. For Miredot this is Java source code and Javadoc. We have just launched a beta version of our brand new Documentation Quality Dashboard to help you improve your docs by pinpointing where Javadoc is missing.

I concisely describe the basic rules we use to check our API design at Miredot. Focus is on URIs/resources and using HTTP methods correctly.