documentation home

Reference Manual

Although Miredot is intended to run 'out of the box', you can configure its settings in order to customize how your sources are processed and determine what the output looks like.

This reference manual should contain everything you need to know in order to tailor Miredot to your needs. If you still have a question, get in touch.

This manual documents all features of Miredot PRO. Note that Miredot BASIC only supports a subset of features. Check the feature comparison table to see the differences.

Supported Frameworks

Miredot parses Java code and annotations. In order to get a full overview of which annotations are processed, please refer to the Supported Frameworks page.

Providing an Organization ID

Miredot requires you to have an account in order to work. You can sign up here. The organization id identifies who you are.

Configuring the Generated Output

Miredot can generate documentation in both html and docx format. Depending on the format, you have a few configuration options.

Rest Model

Miredot constructs an internal model of REST resources while processing your source code. There are a number of ways in which you can influence this process. They are all explained in this section.

Source Code Enhancements

Not often, but sometimes, Miredot needs a little help inspecting the source code or you might want to override its standard behavior. In order to do so, you can use a set of custom Javadoc tags and annotations.

Code Analysis

Miredot analyses your code and can detect a number of issues, such as bad usage of JAX-RS annotations or missing documentation. This section shows you how to configure the handling of these issues.