MW-213 Discover and implement kotlin docs and generate documentation #1861

rohitlokhande47 · 2025-04-07T04:12:38Z

Pull Request

Issue Fix

Fixes #473
Jira Task: [MPW-629](https://mifospay.atlassian.net/browse/MPW-629)

Screenshots and Video

Screen.Recording.2025-04-07.at.9.39.09.AM.mov

Description

Added documentation comments to the codebase and configured Dokka for API documentation generation.

This PR:

Adds Dokka plugin (version 2.0.0) to generate Kotlin documentation
Configures Dokka in multiple modules (feature/accounts, feature/auth) with GitHub source links
Adds comprehensive KDoc comments to AccountViewModel and related classes
Documents methods, properties, and sealed interfaces in the accounts feature
Makes minor configuration adjustments (iOS run config, disabled Gradle configuration cache)

The documentation focuses on explaining the architecture and functionality of components within the accounts feature, making the codebase more maintainable and accessible to new contributors.

No functional code changes were made, only documentation and configuration updates.

Apply the AndroidStyle.xml style template to your code in Android Studio.
Run the unit tests with ./gradlew check to make sure you didn't break anything
If you have multiple commits please combine them into one commit by squashing them.
[

…sses

therajanmaurya · 2025-04-07T04:16:52Z

Good Job @rohitlokhande47
@niyajali review this

Copilot

Copilot reviewed 2 out of 7 changed files in this pull request and generated no comments.

Files not reviewed (5)

.run/mifospay-ios.run.xml: Language not supported
feature/accounts/build.gradle.kts: Language not supported
feature/accounts/src/commonMain/kotlin/org/mifospay/feature/accounts/AccountViewModel.kt: Language not supported
feature/auth/build.gradle.kts: Language not supported
gradle.properties: Language not supported

.run/mifospay-ios.run.xml

therajanmaurya · 2025-04-08T21:40:07Z

feature/accounts/build.gradle.kts

    }
+}
+// Configure Dokka
+tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {


This should be be part of feature and library gradle custom plugin

Move these in feature and library build-logic gradle plugin

therajanmaurya · 2025-04-08T21:41:08Z

feature/auth/build.gradle.kts

    }
+}
+
+tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {


Same as above, it should be moved in feature and library gradle plugin

niyajali · 2025-04-09T09:46:43Z

gradle/libs.versions.toml

 spotless = { id = "com.diffplug.spotless", version.ref = "spotlessVersion" }
 version-catalog-linter = { id = "io.github.pemistahl.version-catalog-linter", version.ref = "versionCatalogLinterVersion" }

+dokka = { id = "org.jetbrains.dokka", version = "2.0.0" }


use a variable for version number of this library like above libraries instead of hardcoding

niyajali · 2025-04-09T09:46:58Z

gradle.properties


 # Enable configuration caching between builds.
-org.gradle.configuration-cache=true
+org.gradle.configuration-cache=false


Revert it back

niyajali · 2025-04-09T09:51:06Z

feature/auth/build.gradle.kts

    }
+}
+
+tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {


Move the Dokka configurations into the root build.gradle.kts file and include the Dokka plugin into the existing KMP Library and CMP Feature Convention plugin. and It will be applied to all the core and feature modules and no need to add the plugin on every module and it will works as expected.

…ion popUpTo references

niyajali

Follow this to set up dokka plugin - https://kotlinlang.org/docs/dokka-gradle.html#multi-project-configuration

niyajali · 2025-04-11T10:53:05Z

build-logic/convention/src/main/kotlin/KMPLibraryConventionPlugin.kt

    override fun apply(target: Project) {
        with(target) {
            with(pluginManager) {
+                apply(KMPLibraryPlugin::class.java)


Why are you adding this?

niyajali · 2025-04-11T10:54:44Z

build-logic/convention/build.gradle.kts


 plugins {
    `kotlin-dsl`
+    alias(libs.plugins.dokka)


remove this

niyajali · 2025-04-11T10:55:00Z

build-logic/convention/build.gradle.kts

    compileOnly(libs.ktlint.gradlePlugin)
    compileOnly(libs.spotless.gradle)
    implementation(libs.truth)
+    implementation(libs.dokka.gradle.plugin)


use compileOnly

niyajali · 2025-04-11T10:55:09Z

build-logic/convention/build.gradle.kts

            implementationClass = "MifosGitHooksConventionPlugin"
            description = "Installs git hooks for the project"
        }
+        register("featureLibrary") {


Remove this plugin we no need such plugin for dokka

niyajali · 2025-04-11T10:55:40Z

build-logic/convention/src/main/kotlin/CMPFeatureConventionPlugin.kt

                apply("org.jetbrains.kotlin.plugin.compose")
                apply("org.jetbrains.compose")
+                apply("org.jetbrains.dokka")
+                apply(KMPLibraryPlugin::class.java)


Remove this plugin apply(KMPLibraryPlugin::class.java)

niyajali · 2025-04-11T11:03:50Z

mifospay-shared/src/commonMain/kotlin/org/mifospay/shared/MifosPayApp.kt

                viewModel.logOut()
                navController.navigate(LOGIN_GRAPH) {
-                    popUpTo(navController.graph.id) {
+                    popUpTo(LOGIN_GRAPH) {


Why are you changing this.. you're about to configure the dokka plugin for documentation, please revert this & below files as it is

yes I will make changes

niyajali · 2025-04-11T11:10:01Z

build-logic/convention/src/main/kotlin/KMPLibraryConventionPlugin.kt

                apply("mifospay.kmp.koin")
                apply("mifos.detekt.plugin")
                apply("mifos.spotless.plugin")
+                apply("org.jetbrains.dokka")


This is sufficient for docs generation

ok I will look into it

niyajali · 2025-04-11T11:11:40Z

build-logic/convention/src/main/kotlin/KMPLibraryPlugin.kt

+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.withType
+
+class KMPLibraryPlugin : Plugin<Project> {


remove this, if required create an extension function and call it where it's required like we did configureKotlinMultiplatform() or configureKotlinAndroid

niyajali · 2025-04-11T11:12:56Z

build.gradle.kts

-}
+}
+
+subprojects {


https://kotlinlang.org/docs/dokka-gradle.html#multi-project-configuration

subprojects {
apply(plugin = "org.jetbrains.dokka")

// configure only the HTML task tasks.dokkaHtmlPartial { outputDirectory.set(layout.buildDirectory.dir("docs/partial")) } // configure all format tasks at once tasks.withType<DokkaTaskPartial>().configureEach { dokkaSourceSets.configureEach { includes.from("README.md") } }

}

niyajali · 2025-04-11T11:13:38Z

feature/accounts/build.gradle.kts

 plugins {
    alias(libs.plugins.mifospay.cmp.feature)
    alias(libs.plugins.kotlin.parcelize)
+    alias(libs.plugins.dokka)


remove these plugins alias(libs.plugins.dokka) and alias(libs.plugins.mifospay.feature.library)

niyajali · 2025-04-11T11:20:23Z

A lot of solutions exist for any given problem, however, adhering to established architectural principles and guidelines streamlines future management and maintenance.

…ion and update build configuration

rohitlokhande47 · 2025-04-15T11:25:07Z

@niyajali fix(shared): replace .id with .route for KMP nav compatibility + Dokka updates

Replaced findStartDestination().id with findStartDestination().route ?: "" in shared module files to fix unresolved reference errors in Compose Multiplatform. .route is multiplatform-safe and preserves existing navigation behavior.

Also ran Dokka for core modules to generate up-to-date documentation without issues.

niyajali

This looks good to me! Once you've implemented the requested changes, please mention us for review—we'll approve and merge it promptly.

Also, moving forward, let's prioritize documenting the core module first. This will help maintain consistency across the project.

niyajali · 2025-04-15T16:01:43Z

build.gradle.kts

+
+// root build.gradle.kts
+tasks.register<DokkaMultiModuleTask>("dokkaHtmlMultiModule") {
+    outputDirectory.set(buildDir.resolve("dokka"))


rename the output dir name is to docs

niyajali · 2025-04-15T16:04:14Z

gradle.properties


 # Enable configuration caching between builds.
-org.gradle.configuration-cache=true
+org.gradle.configuration-cache=false


Let's enable configuration caching to improve build performance. While it may occasionally fail due to cache mismatches, running clean and rebuilding typically resolves the issue. Disabling it would significantly slow down our builds, so the trade-off is worth it.

niyajali · 2025-04-15T16:08:19Z

gradle/libs.versions.toml

 spotless = { id = "com.diffplug.spotless", version.ref = "spotlessVersion" }
 version-catalog-linter = { id = "io.github.pemistahl.version-catalog-linter", version.ref = "versionCatalogLinterVersion" }

+dokka = { id = "org.jetbrains.dokka", version = "2.0.0" }


use the variable dokkaGradlePlugin for version number like version.ref="dokkaGradlePlugin"

Please don't resolve the conversion even though you fixed it.

niyajali · 2025-04-15T16:08:50Z

gradle/libs.versions.toml

 androidx-tracing-ktx = { group = "androidx.tracing", name = "tracing-ktx", version.ref = "androidxTracing" }

+dokka-gradle-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokkaGradlePlugin" }
+kotlinx-coroutines-core-v173 = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinxCoroutinesCore" }


Remove this duplicate library, we do have kotlinx-coroutines-core use that one instead.

niyajali · 2025-04-15T16:09:23Z

mifospay-shared/build.gradle.kts

            implementation(projects.feature.qr)
            implementation(projects.feature.merchants)
            implementation(projects.feature.upiSetup)
+            implementation(libs.kotlinx.coroutines.core.v173)


use the existing kotlinx-coroutines-core library

niyajali · 2025-04-15T16:14:45Z

mifospay-shared/src/commonMain/kotlin/org/mifospay/shared/MifosPayApp.kt

                viewModel.logOut()
                navController.navigate(LOGIN_GRAPH) {
-                    popUpTo(navController.graph.id) {
+                    popUpTo(navController.graph.findStartDestination().route ?: "") {


To confirm this functionality works as expected after the changes, please provide screen recordings demonstrating:

login into the account

Navigation to a sample screen

Logout flow

Back button behavior – Verify whether pressing 'Back' after logout reopens the app or stays on the login screen

niyajali · 2025-04-15T16:16:11Z

mifospay-shared/src/commonMain/kotlin/org/mifospay/shared/navigation/PasscodeNavGraph.kt

        // avoid building up a large stack of destinations
        // on the back stack as users select items
-        popUpTo(graph.findStartDestination().id) {
+        popUpTo(graph.findStartDestination().route ?: "") {


Similar like above please upload video to verify navigation is working as expected or not

niyajali · 2025-04-15T16:16:18Z

mifospay-shared/src/commonMain/kotlin/org/mifospay/shared/ui/MifosAppState.kt

                // avoid building up a large stack of destinations
                // on the back stack as users select items
-                popUpTo(navController.graph.findStartDestination().id) {
+                popUpTo(navController.graph.findStartDestination().route ?: "") {


Similar like above please upload video to verify navigation is working as expected or not

niyajali · 2025-04-15T16:19:54Z

build-logic/convention/src/main/kotlin/org/mifospay/Dokka.kt

+ * applying the same configuration to the target Project.
+ */
+// Add this in a shared convention plugin or utilities script
+fun Project.configureFeatureDocumentation() {


We can remove these configs since we've already defined similar ones in the root build.gradle.kts, which apply project-wide. These should work as expected. Please let us know if you think these serve a different purpose.

…enabling configuration caching

rohitlokhande47 · 2025-04-16T16:35:01Z

The org/mifospay/Dokka.kt file enables per-feature Dokka customization—setting output dirs, naming docs by module, and handling multiplatform setups. Removing it may break consistency, naming, and platform-specific config.

niyajali · 2025-05-12T12:37:24Z

@rohitlokhande47 Hi, is there's no update on this PR, have you tested the navigation is it working as before?

…docs-and-generate-documentation

feat: Add documentation comments for AccountViewModel and related cla…

114ae9b

…sses

therajanmaurya requested review from Copilot and niyajali April 7, 2025 04:16

Copilot AI reviewed Apr 7, 2025

View reviewed changes

therajanmaurya requested changes Apr 8, 2025

View reviewed changes

niyajali requested changes Apr 9, 2025

View reviewed changes

feat: Add FeatureLibraryPlugin and update build configuration

27518ad

rohitlokhande47 requested review from niyajali and therajanmaurya April 9, 2025 14:41

rohitlokhande47 added 2 commits April 11, 2025 00:09

feat: Integrate Dokka for documentation generation and update navigat…

d23b76b

…ion popUpTo references

feat: Integrate Dokka for documentation generation and update navigat…

7b524a7

…ion popUpTo references

niyajali requested changes Apr 11, 2025

View reviewed changes

rohitlokhande47 added 2 commits April 15, 2025 16:40

feat: Refactor navigation popUpTo references to use findStartDestinat…

93415f6

…ion and update build configuration

feat: Refactor navigation popUpTo references to use findStartDestinat…

3607573

…ion and update build configuration

niyajali requested changes Apr 15, 2025

View reviewed changes

feat: Update build configuration by removing unused dependencies and …

7c8fdad

…enabling configuration caching

Merge branch 'development' into MW-213-discover-and-implement-kotlin-…

abd4782

…docs-and-generate-documentation

MW-213 Discover and implement kotlin docs and generate documentation #1861

Are you sure you want to change the base?

MW-213 Discover and implement kotlin docs and generate documentation #1861

Uh oh!

Conversation

rohitlokhande47 commented Apr 7, 2025

Pull Request

Issue Fix

Screenshots and Video

Description

Uh oh!

therajanmaurya commented Apr 7, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niyajali Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niyajali left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niyajali Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niyajali Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niyajali Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niyajali commented Apr 11, 2025

Uh oh!

rohitlokhande47 commented Apr 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

niyajali left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

niyajali Apr 9, 2025 •

edited

Loading

niyajali Apr 11, 2025 •

edited

Loading

niyajali Apr 11, 2025 •

edited

Loading

niyajali Apr 11, 2025 •

edited

Loading

rohitlokhande47 commented Apr 15, 2025 •

edited

Loading