Finish documentation

MateriiApps · Dec 8, 2023 · 7766625 · 7766625
1 parent 2c5f570
commit 7766625
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 10 deletions.
diff --git a/app/src/main/java/xyz/wingio/dimett/ast/Renderer.kt b/app/src/main/java/xyz/wingio/dimett/ast/Renderer.kt
@@ -10,6 +10,14 @@ import xyz.wingio.syntakts.compose.rememberAsyncRendered
 import xyz.wingio.syntakts.markdown.addBasicMarkdownRules
 import xyz.wingio.syntakts.syntakts
 
+/**
+ * Renders a formatted version of [text]
+ *
+ * @param text Text to parse and format
+ * @param emojiMap Used to insert custom emoji into the text
+ * @param mentionMap All the users mentioned in the post
+ * @param actionHandler Callback that is passed the actions name
+ */
 @Composable
 fun Syntakts<DefaultRenderContext>.render(
     text: String,
@@ -21,6 +29,11 @@ fun Syntakts<DefaultRenderContext>.render(
     context = rememberRenderContext(emojiMap, mentionMap, actionHandler)
 )
 
+/**
+ * Creates a remembered version of [DefaultRenderContext]
+ *
+ * @see DefaultRenderContext
+ */
 @Composable
 fun rememberRenderContext(
     emojiMap: Map<String, String>,
@@ -35,6 +48,9 @@ fun rememberRenderContext(
     }
 }
 
+/**
+ * Contains all the rules for rendering post content
+ */
 val DefaultSyntakts = syntakts {
     addHashtagRule()
     addMentionRule()
@@ -43,13 +59,19 @@ val DefaultSyntakts = syntakts {
     addUnicodeEmojiRule()
 }
 
+/**
+ * Contains the rules for rendering styled string resources
+ */
 val StringSyntakts = syntakts {
     addUrlRule()
     addClickableRule()
     addBasicMarkdownRules()
     addUnicodeEmojiRule()
 }
 
+/**
+ * Only contains rules necessary for emotes and Twemoji
+ */
 val EmojiSyntakts = syntakts {
     addEmojiRule()
     addUnicodeEmojiRule()

diff --git a/app/src/main/java/xyz/wingio/dimett/ast/Rules.kt b/app/src/main/java/xyz/wingio/dimett/ast/Rules.kt
@@ -8,22 +8,22 @@ import xyz.wingio.syntakts.compose.style.toSyntaktsColor
 import xyz.wingio.syntakts.style.Style
 
 const val urlRegex =
-    "https?:\\/\\/([\\w+?]+\\.[\\w+]+)([a-zA-Z0-9\\~\\!\\@\\#\\\$\\%\\^\\&\\*\\(\\)_\\-\\=\\+\\\\\\/\\?\\.\\:\\;\\'\\,]*)?"
+    "https?:\\/\\/([\\w+?]+\\.[\\w+]+)([a-zA-Z0-9\\~\\!\\@\\#\\\$\\%\\^\\&\\*\\(\\)_\\-\\=\\+\\\\\\/\\?\\.\\:\\;\\'\\,]*)?" // https://example.com
 
 const val hyperlinkRegex =
-    "\\[(.+?)\\]\\(($urlRegex)\\)"
+    "\\[(.+?)\\]\\(($urlRegex)\\)" // [link](https://example.com)
 
 const val clickableRegex =
-    "\\[(.+?)\\]\\{(.+?)\\}"
+    "\\[(.+?)\\]\\{(.+?)\\}" // [some text]{onSomeAction}
 
 const val emojiRegex =
-    ":(.+?):"
+    ":(.+?):" // :shortcode:
 
 const val mentionRegex =
-    "@(\\S+?)\\b(@(\\S+)\\b)?"
+    "@(\\S+?)\\b(@(\\S+)\\b)?" // @user or @[email protected]
 
 const val hashtagRegex =
-    "#(.+?)\\b"
+    "#(.+?)\\b" // #sometext
 
 fun Syntakts.Builder<DefaultRenderContext>.addUrlRule() {
     rule(urlRegex) { result, context ->

diff --git a/app/src/main/java/xyz/wingio/dimett/ast/rendercontext/DefaultRenderContext.kt b/app/src/main/java/xyz/wingio/dimett/ast/rendercontext/DefaultRenderContext.kt
@@ -4,9 +4,9 @@ import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.platform.UriHandler
 
 data class DefaultRenderContext(
-    val emojiMap: Map<String, String>,
-    val mentionMap: Map<String, String>,
+    val emojiMap: Map<String, String>, // shortcode: url
+    val mentionMap: Map<String, String>, // username to id
     val linkColor: Color,
     val uriHandler: UriHandler,
-    val clickActionHandler: (String) -> Unit
+    val clickActionHandler: (String) -> Unit // Is passed the action name (Ex. onUserClick)
 )
diff --git a/app/src/main/java/xyz/wingio/dimett/di/HttpModule.kt b/app/src/main/java/xyz/wingio/dimett/di/HttpModule.kt
@@ -27,7 +27,7 @@ val httpModule = module {
         defaultRequest {
             header(
                 HttpHeaders.UserAgent,
-                "Dimett/${BuildConfig.APPLICATION_ID} v${BuildConfig.VERSION_NAME} (${BuildConfig.VERSION_CODE})${if (BuildConfig.DEBUG) " - Debug" else ""}"
+                "Dimett/${BuildConfig.APPLICATION_ID} v${BuildConfig.VERSION_NAME} (${BuildConfig.VERSION_CODE})" // Dimett/xyz.wingio.dimett v1.0.0 (1)
             )
         }
         install(Logging) {