add doc

ComposeGears · Nov 4, 2024 · 8bf5c08 · 8bf5c08
1 parent 72a92a3
commit 8bf5c08
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/tiamat/src/commonMain/kotlin/com/composegears/tiamat/Extension.kt b/tiamat/src/commonMain/kotlin/com/composegears/tiamat/Extension.kt
@@ -2,16 +2,27 @@ package com.composegears.tiamat
 
 import androidx.compose.runtime.Composable
 
+/**
+ * Extension base class
+ */
 public abstract class Extension<Args> {
 
     @Composable
     internal fun ExtensionContent(scope: NavDestinationScope<Args>) {
         scope.content()
     }
 
+    /**
+     * The content of extension
+     */
     @Composable
     public abstract fun NavDestinationScope<Args>.content()
 }
 
+/**
+ * Provides an attached extension of defined type
+ *
+ * @return extension or null if the ext of this type is not attached
+ */
 public inline fun <reified P : Extension<*>> NavDestination<*>.ext(): P? =
     extensions.firstOrNull { it is P } as? P?