Sitelet https://web.archive.org/web/20200601104720/https://github.com/square/leakcanary/issues/1745
Skip to content

/ leakcanary

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

Jump to bottom

Dokka reports a lot of warnings #1745

Open
Armaxis opened this issue Feb 6, 2020 · 3 comments
Open

Dokka reports a lot of warnings #1745

Armaxis opened this issue Feb 6, 2020 · 3 comments
Labels
good first issue status: help wanted type: documentation

Comments

@Armaxis
Copy link
Member

@Armaxis 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 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 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 pyricau commented Feb 24, 2020

Also, Dokka should link Android classes to the Android doc reference
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue status: help wanted type: documentation
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@pyricau @Armaxis
You can’t perform that action at this time.