-
Notifications
You must be signed in to change notification settings - Fork 742
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
Set up dokka to generate SDK documentation and cleanup the API #5744
Merged
Merged
Changes from all commits
Commits
Show all changes
81 commits
Select commit
Hold shift + click to select a range
4d49cca
Configure Dokka plugin to generate Kdoc
bmarty dc092f8
Add missing `internal` keyword.
bmarty 83570dc
Move TextContent class to `api` package
bmarty b4dbb38
Internal + add some doc
bmarty 73d22d0
Move SpacePeekResult to api package, and cleanup
bmarty 7711eb5
Move `SignInvitationResult` and `RoomAliasDescription` to api package
bmarty 567f298
Remove unused code.
bmarty 24d044b
Move `DeviceTrustLevel`, `DeviceTrustResult` and `UserTrustResult` to…
bmarty 1684ba1
Move `ElementToDecrypt` to api package
bmarty 3895ac8
Move `SyncService` to api package
bmarty a3575fb
Move `PrivateKeysInfo` to api package
bmarty 03dba3b
Move `SavedKeyBackupKeyInfo` to api package
bmarty 0cb7703
Move content data class to api package
bmarty ccce552
Move `md5()` extension to api package
bmarty 627a129
Move `awaitCallback()` extension to api package
bmarty d4ff273
Move `TermsResponse` to api package
bmarty c9bbf6c
Move `RecoveryKey` functions to api package
bmarty f4fba2d
Check usage of `import org.matrix.android.sdk.internal` app side
bmarty 0720196
Move `CryptoDeviceInfo` to api package
bmarty b1f4aa9
Move `Fingerprint` to api package
bmarty d8eac14
`MoshiProvider` is now internal. Create MatrixJsonParser to expose it…
bmarty 1bc6bec
Move `Base64` facility to api package
bmarty 4b74010
Move `ImportRoomKeysResult` to api package
bmarty 229547f
Move `KeysVersionResult` to api package
bmarty 36fd570
Move `KeysBackupVersionTrust` to api package
bmarty 97c1929
Move `KeysBackupLastVersionResult` to api package
bmarty e6fc723
Move `KeysVersion` to api package
bmarty 7644bd4
Move `IncomingRequestCancellation` to api package
bmarty e9161dd
Move `IncomingSecretShareRequest` to api package
bmarty af2825e
Move `DeviceInfo` to api package
bmarty e6bc630
Move `MegolmBackupCreationInfo` to api package
bmarty 4799326
Move `IncomingRoomKeyRequest` to api package
bmarty 897c711
Move `OutgoingRoomKeyRequest` to api package
bmarty a054080
Move `OlmDecryptionResult` to api package
bmarty ed8097e
Create Settings module to add interface for LightweightSettingsStorage
bmarty c519674
Move `DevicesListResponse` to api package
bmarty 9190b8b
Move `DefaultBaseAuth` to api package
bmarty 47dad42
Move `RoomKeyShareRequest` to api package
bmarty 363524b
Move `ForwardedRoomKeyContent` to api package
bmarty f8d0a22
Remove `combineLatest` from SDK, and cleanup
bmarty 1402416
Move `MXUsersDevicesMap` to api package
bmarty 3735ac3
Add entry to keyBackupService to expose `deriveKey`, which becomes in…
bmarty 16c8296
`toQrCodeData()` is now internal
bmarty 02cc9d6
Move `InitialSyncStrategy` to api package
bmarty 0f6b47e
Move `NewSessionListener` to api package
bmarty 74e475d
Move `CryptoConstants` to api package
bmarty 1403557
Move `LocalizedFlowDataLoginTerms` to api package
bmarty 814ba43
Move `andThen` extension to app module
bmarty 0107836
Extract `GossipingDefaultContent` to its own file
bmarty e8bfbdd
Move `GossipingToDeviceObject` to api package
bmarty e915413
Move `SecretShareRequest` to api package
bmarty c0aafab
Move to the other package about crypto
bmarty 4e88b7f
Move `CryptoCrossSigningKey` to api package
bmarty 5c6b370
Add `explicit-api` compiler option for hte SDK module. Disabled for now.
bmarty b5654d5
Move `InteractiveAuthenticationFlow` to api package
bmarty d4d74d3
Move `ThreePidCredentials` to its own file and make it internal
bmarty d0a4075
Move `TaggedEventsContent` to api package
bmarty 90e6c07
Split into several files
bmarty c11194d
Move `GossipingRequestState` and `OutgoingGossipingRequestState` to a…
bmarty 2b7144c
Make it clear in the generated doc that some class must not be used.
bmarty 1123650
Move `MXEventDecryptionResult` to api package
bmarty a479e18
internal
bmarty f56ea8b
Move `KeysBackupVersionTrustSignature` to api package
bmarty 851708c
Add some todos
bmarty cc1fc29
Move `MegolmBackupAuthData` to api package
bmarty 6682170
Move `MXDeviceInfo` to api package
bmarty d07f269
Move `MXEncryptEventContentResult` to api package
bmarty 7eaef93
`DeviceKeys` is now internal, removing unused code.
bmarty ed94d3f
Move `EncryptedFileInfo` and `EncryptedFileKey` to api package
bmarty 89f20e1
Move `RoomKeyRequestBody` to api package
bmarty b6eafbe
Move `SendToDeviceObject` to api package
bmarty 150c643
Move `UnsignedDeviceInfo` to api package
bmarty 7327047
Rename .java to .kt
bmarty 7514edb
Convert RuntimeJsonAdapterFactory to Kotlin
bmarty 4e48c07
Make RuntimeJsonAdapterFactory internal and cleanup
bmarty 23d2a29
Global import optimization
bmarty bfbcef6
Run ktlintFormat
bmarty a0eb4c1
Add changelog files
bmarty 38bbbd6
Restore the correct copyright
bmarty c8aefd5
Update issue hint
bmarty e30c68f
Remove dokka dependencies classpath for this specific module, it's al…
bmarty File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Setup Dokka to be able to generate documentation of the SDK module. Run `./gradlew matrix-sdk-android:dokkaHtml` to do it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
A lot of classes which were exposed to the clients and were located in the package `org.matrix.android.sdk.internal` have been moved to the package `org.matrix.android.sdk.api`. | ||
All the classes which are in the package `org.matrix.android.sdk.internal` should now be declared `internal`. | ||
Some unused code and classes have been removed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,7 @@ apply plugin: 'kotlin-android' | |
apply plugin: 'kotlin-kapt' | ||
apply plugin: 'kotlin-parcelize' | ||
apply plugin: 'realm-android' | ||
apply plugin: "org.jetbrains.dokka" | ||
|
||
buildscript { | ||
repositories { | ||
|
@@ -73,6 +74,10 @@ android { | |
|
||
kotlinOptions { | ||
jvmTarget = "11" | ||
freeCompilerArgs += [ | ||
// Disabled for now, there are too many errors. Could be handled in another dedicated PR | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
// '-Xexplicit-api=strict', // or warning | ||
] | ||
} | ||
|
||
sourceSets { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do not need this while it is already defined in the
matrix-sdk-android/build.gradle
. I also tested it and works fine without itThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, you are right. I will keep this one and remove the line in the matrix sdk build.gradle file, if ever we need to generate documentation for another module (such as matrix-sdk-android-flow for instance)