Dokka: Java package-info.html files not included in documentation

Created on 8 Mar 2016  路  3Comments  路  Source: Kotlin/dokka

I'd like my Java classes to have package-level documentation. I've setup the package-info.html files in each package and it works for my Gradle Javadoc task, but when I run ./gradlew dokka the text in the package-info.html files is nowhere to be seen.

enhancement

Most helpful comment

Javadoc content from package-info.java files is ignored as well.

All 3 comments

Javadoc content from package-info.java files is ignored as well.

Maybe a small point, but the java conventions are package.html and package-info.java - there was never a package-info.html. You might want to change the title of this issue to reflect that. I would be happy for dokka to work automatically with either of those, and/or something dokka-specific like package.md or module.md.

I wrote something else here, but I think I'm going to treat it as a separate issue instead.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Groostav picture Groostav  路  6Comments

joserobjr picture joserobjr  路  4Comments

norswap picture norswap  路  4Comments

juergenzimmermann picture juergenzimmermann  路  3Comments

xit0c picture xit0c  路  4Comments