micronaut-build icon indicating copy to clipboard operation
micronaut-build copied to clipboard

Documentation with api: prefix always adds io.micronaut prefix

Open radovanradic opened this issue 1 year ago • 0 comments

Projects generating documentation from ascii doc files and having api: links will always add io.micronaut prefix to the API links even when API does not belong to Micronaut libraries. Would be good, if possible, to configure api links and tell they don't belong to Micronaut but that current project so prefix is not added. This is done for manually added api links as well as auto generated configuration references. An example of test that shows how links are being generated:

class CommonApiMacroSpec extends AbstractConverterSpec {
    def "api module always adds io.micronaut prefix"() {
        when:
        convert "api:net.example.ServiceSettings[]"

        then:
        converted == '<div class="paragraph">\n<p><a href="../api/io/micronaut/net/example/ServiceSettings.html">ServiceSettings</a></p>\n</div>'
    }
}

this should not contain /io/micronaut/ prefix in the API link.

radovanradic avatar Dec 19 '23 08:12 radovanradic