Change the dokka output format from the javadoc style to the native dokka style #27516
Conversation
|
Thanks for your pull request! The title of your pull request does not follow our editorial rules. Could you have a look?
|
quarkus-bot
bot
added
area/dependencies
evanchooly
changed the title
|
|
This comment has been minimized.
This comment has been minimized.
quarkus-bot
bot
added
area/devtools
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-jar-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>dokka-jar</id> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>jar</goal> | ||
| </goals> | ||
| <configuration> | ||
| <classifier>javadoc</classifier> | ||
| <classesDirectory>${project.build.directory}/dokka</classesDirectory> | ||
| <skipIfEmpty>true</skipIfEmpty> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> |
There was a problem hiding this comment.
The dokka goal only generates the docs. we need the extra step to create and attach the jar.
This comment has been minimized.
This comment has been minimized.
|
The The |
ah! found a typo in the template text. rebased while I was at it to try to get the MP test fixes. |
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-jar-plugin</artifactId> | ||
| <executions> | ||
| <execution> | ||
| <id>dokka-jar</id> | ||
| <phase>package</phase> | ||
| <goals> | ||
| <goal>jar</goal> | ||
| </goals> | ||
| <configuration> | ||
| <classifier>javadoc</classifier> | ||
| <classesDirectory>${project.build.directory}/dokka</classesDirectory> | ||
| <skipIfEmpty>true</skipIfEmpty> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| </plugin> |
There was a problem hiding this comment.
AFAICS the dokka goal (unlike the javadocJar goal) is not creating a javadoc jar, which is compensated by this jar-plugin execution.
Looks like a limitation of the plugin: https://kotlin.github.io/dokka/1.7.10/user_guide/maven/usage/ (see goal descriptions and config options)
The dokka format has come a long way since it first started. It's now quite clean and easy to read. This will be a more idiomatic experience for our kotlin users.