documentation home

Title Naming

For the title of your interfaces, Miredot by default looks for the @summary Javadoc tag, then the @title Javadoc tag (read the custom Javadoc tag documentation) and as a last resort, uses the first sentence of the interface documentation. This behavior can be changed in the configuration of the plugin. This is the default config:

Maven
<configuration>
    <restModel>
        <titleNamingStrategies>
            <strategy>tag: title</strategy>
            <strategy>tag: summary</strategy>
            <strategy>firstsentence</strategy>
        </titleNamingStrategies>
    </restModel>
</configuration>
Gradle
miredot {
    restModel {
        titleNamingStrategies = [
            'tag: summary', 
            'tag: title', 
            'firstsentence'
        ]
    }
}