fix: android docs [WPB-16037]

[typfel]

What's new in this PR

Re-enable android docs via dokka.

---

PR Submission Checklist for internal contributors

• The PR Title
  • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
  • contains a reference JIRA issue number like SQPIT-764
  • answers the question: If merged, this PR will: ... ³

1. https://sparkbox.com/foundry/semantic_commit_messages
2. https://github.com/wireapp/.github#usage
3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

[github-actions]

Bencher Report

Branch	fix/android-docs-WPB-16037
Testbed	ubuntu-latest

Click to view all benchmark results

Benchmark	Latency	milliseconds (ms)
Commit add f(group size)/cs1/mem/1002	📈 view plot 🚷 view threshold	19.00 ms
Commit add f(group size)/cs1/mem/2	📈 view plot 🚷 view threshold	6.95 ms
Commit add f(group size)/cs1/mem/202	📈 view plot 🚷 view threshold	9.58 ms
Commit add f(group size)/cs1/mem/402	📈 view plot 🚷 view threshold	12.07 ms
Commit add f(group size)/cs1/mem/602	📈 view plot 🚷 view threshold	15.17 ms
Commit add f(group size)/cs1/mem/802	📈 view plot 🚷 view threshold	17.07 ms
Commit add f(number clients)/cs1/mem/1002	📈 view plot 🚷 view threshold	986.11 ms
Commit add f(number clients)/cs1/mem/2	📈 view plot 🚷 view threshold	7.07 ms
Commit add f(number clients)/cs1/mem/202	📈 view plot 🚷 view threshold	85.06 ms
Commit add f(number clients)/cs1/mem/402	📈 view plot 🚷 view threshold	221.60 ms
Commit add f(number clients)/cs1/mem/602	📈 view plot 🚷 view threshold	427.63 ms
Commit add f(number clients)/cs1/mem/802	📈 view plot 🚷 view threshold	673.66 ms
Commit pending proposals f(group size)/cs1/mem/1002	📈 view plot 🚷 view threshold	116.50 ms
Commit pending proposals f(group size)/cs1/mem/2	📈 view plot 🚷 view threshold	28.54 ms
Commit pending proposals f(group size)/cs1/mem/202	📈 view plot 🚷 view threshold	46.35 ms
Commit pending proposals f(group size)/cs1/mem/402	📈 view plot 🚷 view threshold	61.11 ms
Commit pending proposals f(group size)/cs1/mem/602	📈 view plot 🚷 view threshold	79.93 ms
Commit pending proposals f(group size)/cs1/mem/802	📈 view plot 🚷 view threshold	95.00 ms
Commit pending proposals f(pending size)/cs1/mem/1	📈 view plot 🚷 view threshold	19.31 ms
Commit pending proposals f(pending size)/cs1/mem/101	📈 view plot 🚷 view threshold	115.73 ms
Commit pending proposals f(pending size)/cs1/mem/21	📈 view plot 🚷 view threshold	36.01 ms
Commit pending proposals f(pending size)/cs1/mem/41	📈 view plot 🚷 view threshold	57.36 ms
Commit pending proposals f(pending size)/cs1/mem/61	📈 view plot 🚷 view threshold	76.85 ms
Commit pending proposals f(pending size)/cs1/mem/81	📈 view plot 🚷 view threshold	96.17 ms
Commit remove f(group size)/cs1/mem/1002	📈 view plot 🚷 view threshold	27.71 ms
Commit remove f(group size)/cs1/mem/2	📈 view plot 🚷 view threshold	6.84 ms
Commit remove f(group size)/cs1/mem/202	📈 view plot 🚷 view threshold	9.14 ms
Commit remove f(group size)/cs1/mem/402	📈 view plot 🚷 view threshold	12.50 ms
Commit remove f(group size)/cs1/mem/602	📈 view plot 🚷 view threshold	17.83 ms
Commit remove f(group size)/cs1/mem/802	📈 view plot 🚷 view threshold	22.26 ms
Commit remove f(number clients)/cs1/mem/1002	📈 view plot 🚷 view threshold	30.01 ms
Commit remove f(number clients)/cs1/mem/2	📈 view plot 🚷 view threshold	138.74 ms
Commit remove f(number clients)/cs1/mem/202	📈 view plot 🚷 view threshold	116.19 ms
Commit remove f(number clients)/cs1/mem/402	📈 view plot 🚷 view threshold	95.01 ms
Commit remove f(number clients)/cs1/mem/602	📈 view plot 🚷 view threshold	73.67 ms
Commit remove f(number clients)/cs1/mem/802	📈 view plot 🚷 view threshold	51.42 ms
Commit update f(group size)/cs1/mem/1002	📈 view plot 🚷 view threshold	138.04 ms
Commit update f(group size)/cs1/mem/2	📈 view plot 🚷 view threshold	7.03 ms
Commit update f(group size)/cs1/mem/202	📈 view plot 🚷 view threshold	33.83 ms
Commit update f(group size)/cs1/mem/402	📈 view plot 🚷 view threshold	60.08 ms
Commit update f(group size)/cs1/mem/602	📈 view plot 🚷 view threshold	87.45 ms
Commit update f(group size)/cs1/mem/802	📈 view plot 🚷 view threshold	113.12 ms

🐰 View full continuous benchmarking report in Bencher

[coriolinus]

Looking at the output that CI generated (here), we see many instances of <Error class: unknown class>) in places where end users probably want to know specifically what goes in the constructor.

That said, some docs are better than no docs, so I'm approving this.

[typfel]

Looking at the output that CI generated (here), we see many instances of <Error class: unknown class>) in places where end users probably want to know specifically what goes in the constructor.

That said, some docs are better than no docs, so I'm approving this.

Ah interesting this is referencing internal uniffi classes so the problem is likely these methods shouldn't be public.

[coriolinus]

Huh. Those are the constructors though. How does a client in Kotlin get ahold of a CoreCrypto instance if not via the constructor?

[istankovic]

@typfel why not fix WPB-16036 first?

[typfel]

@typfel why not fix WPB-16036 first?

Because it relies on this PR. In WPB-16036 i will use what I setup here like this:

cd bindings
./gradlew android:dokkaHtml
cp -r dokka/html target/docs/..

[typfel]

Huh. Those are the constructors though. How does a client in Kotlin get ahold of a CoreCrypto instance if not via the constructor?

They are internal constructors there other constructors as well.

[istankovic]

@typfel why not fix WPB-16036 first?

Because it relies on this PR. In WPB-16036 i will use what I setup here like this:
[...]

Ah, I missed that you already moved to Dokka 2 in this PR, nice!

[istankovic]

It would be nice to fix the following warning, but that can also be done as part of another PR:

> Configure project :
warning: Dokka Gradle plugin V1 is deprecated
                                                                                                                                                                                                                                                           
    Dokka Gradle plugin V1 is deprecated, and will be removed in Dokka version 2.1.0
    Please migrate to Dokka Gradle plugin V2. This will require updating your project.
    To learn about migrating read the migration guide https://kotl.in/dokka-gradle-migration
                                                                                                                                                                                                                                                           
    To start migrating to Dokka Gradle plugin V2 add
        org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers
    into your project's `gradle.properties` file.
                                                                                                                                                                                                                                                           
    We would appreciate your feedback!
     - Please report any feedback or problems https://kotl.in/dokka-issues
     - Chat with the community visit #dokka in https://kotlinlang.slack.com/ (To sign up visit https://kotl.in/slack)