Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dokka reports a lot of warnings #1745

Closed
Armaxis opened this issue Feb 6, 2020 · 5 comments
Closed

Dokka reports a lot of warnings #1745

Armaxis opened this issue Feb 6, 2020 · 5 comments

Comments

@Armaxis
Copy link
Member

Armaxis commented Feb 6, 2020

Run following commands and enjoy the stream of warnings from Dokka:

rm -rf docs/api
./gradlew leakcanary-android-core:dokka leakcanary-android-instrumentation:dokka leakcanary-android-process:dokka leakcanary-object-watcher-android:dokka leakcanary-object-watcher:dokka shark-android:dokka shark-graph:dokka shark-hprof:dokka shark-log:dokka shark:dokka

Review errors and see if any of them can be properly resolved or safely ignored.

Full report:
dokka log.txt

@Armaxis
Copy link
Member Author

Armaxis commented Feb 7, 2020

Looks like a lot of warnings are because of linking to another modules.
There are possible solutions here: Kotlin/dokka#157

@Armaxis
Copy link
Member Author

Armaxis commented Feb 23, 2020

https://jeroenmols.com/blog/2020/02/19/dokka-code-documentation/
Related article on setting up multinodular

@pyricau
Copy link
Member

pyricau commented Feb 24, 2020

Also, Dokka should link Android classes to the Android doc reference

@Armaxis
Copy link
Member Author

Armaxis commented Aug 4, 2020

Official Dokka multimodule support is coming in 1.4!
https://blog.jetbrains.com/kotlin/2020/08/dokka-preview-based-on-kotlin-1-4-0-rc/

@pyricau
Copy link
Member

pyricau commented Apr 21, 2022

Updated to multimodule: #2368

@pyricau pyricau closed this as completed Apr 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants