Add back kdoc for packaged font functions

tclement0922 · Sep 8, 2024 · 900cc63 · 900cc63
1 parent aa7f98b
commit 900cc63
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/plugins/src/main/kotlin/dev/tclement/fonticons/FAVariant.kt b/plugins/src/main/kotlin/dev/tclement/fonticons/FAVariant.kt
@@ -58,6 +58,9 @@ private abstract class CreateFAVariantTask : DefaultTask() {
             )
         """.trimIndent()
             )
+            .addKdoc("""
+            The FontAwesome Free ${variant.uppercaseFirstChar()} font.
+            """.trimIndent())
             .build()
         fileSpecBuilder.addFunction(functionSpec)
         fileSpecBuilder.addImport("dev.tclement.fonticons", "rememberStaticIconFont")

diff --git a/plugins/src/main/kotlin/dev/tclement/fonticons/SymbolsVariant.kt b/plugins/src/main/kotlin/dev/tclement/fonticons/SymbolsVariant.kt
@@ -57,6 +57,12 @@ private abstract class CreateSymbolsVariantTask : DefaultTask() {
         val expectFunctionSpec = commonFunSpec()
             .addParameter(ParameterSpec.builder("grade", Int::class).defaultValue("0").build())
             .addParameter(ParameterSpec.builder("fill", Boolean::class).defaultValue("false").build())
+            .addKdoc("""
+            The Material Symbols variable font, ${variant.uppercaseFirstChar()} variant.
+            
+            @param grade grade of the font, between -50 and 200, 0 by default
+            @param fill whether to use the filled variation of the icons or not, false by default
+            """.trimIndent())
             .addModifiers(KModifier.EXPECT)
             .build()
         commonFileSpecBuilder.addFunction(expectFunctionSpec)