search

orchidhq / Orchid

Build and deploy beautiful documentation sites that grow with you
https://orchid.run
GNU General Public License v3.0
514 stars 53 forks source link

KDoc does not render Java varargs correctly #276

Closed DanySK closed 5 years ago

DanySK commented 5 years ago

I stumbled upon what seems to be a bug. I'm rendering the documentation for this class, whose relevant method is:


    public Position makePosition(final Number... coordinates) {
        // stuff
    }

Dokka renders the class badly at the moment due to Kotlin/dokka#361. I will shortly update to Dokka 0.9.18 to see if that's solved. I don't think it's related, since Orchid uses its own rendering engine, but there is no information stored for such vararg argument, here is a rendered example.

cjbrooks12 commented 5 years ago

This has been fixed in the Kodiak formatters as of 0.3.2, and work is underway to get Orchid integrated with the new Kodiak formatters. It will be available in the next major release.