JavaDoc Hosting

Request details

(I’ve searched a lot but couldn’t find any requests related to this topic, so here I am, but sorry if it’s a duplicate)

My idea/request is simple:

Host JavaDoc pages from the maven repo -javadoc.jar file as a static page in an iframe. The iframe would be embedded in the main site on a separate route. (For security the headers would only allow iframes from the same-origin) This feature would also introduce a separate badge that would show the version of the latest JavaDoc available for a specified artifact or N/A if there are no available ones.

If it detects that the published artifact has a Javadoc generated along with it, with RegExp for example; the backend could extract the HTML content with the following: The -javadoc.jar file is actually just like a “zip”, it only contains the HTML pages. By running the command: jar xf *-javadoc.jar, it will extract the jar’s content into the folder it’s in. (* would be the artifact name).

(P.S: I’d create a pull request and implement it myself, but I don’t have much experience with Kotlin, Javalin, and especially with your codebase. Once I learn it - will probably do - I most likely come back and implement it myself, if someone else hasn’t implemented it by that time)

[TOTHT0MI]

Rename java directory to kotlin in your sources 😃

Oh well… Yeah now it has a source so I assume it’s gonna boot up. The more you know, yeah forgot to do that when converting from java to Kotlin. Thanks.

[TOTHT0MI]

With Kotlin, you can just simply use reified function:

val mavenFacade = extensions().facade<MavenFacade>() // gets facade by generic type

But yeah, it misses standard class based getter for Java API. I’ll add in next release. Btw you’re trying to write it in Java or Kotlin?

Well first in Java, because I feel more comfortable with it, but I assume it can easily be converted into Kotlin down the line.