From d2daeee75d12ffaad07c5fef7185fd3fde01b5ab Mon Sep 17 00:00:00 2001
From: Kieran W <41634689+FredHappyface@users.noreply.github.com>
Date: Fri, 11 Mar 2022 18:36:29 +0000
Subject: [PATCH] documentation improvements and styles tidy up

---
 .../fredhappyface/ewesticker/StickerImporter.kt |  4 ++--
 .../fredhappyface/ewesticker/StickerSender.kt   |  4 +++-
 app/src/main/res/values-v27/styles.xml          |  2 --
 app/src/main/res/values/styles.xml              | 17 -----------------
 .../-sticker-importer/import-stickers.md        |  4 ++--
 .../-sticker-importer/index.md                  |  2 +-
 .../-sticker-sender/index.md                    |  2 +-
 .../-sticker-sender/send-sticker.md             |  2 +-
 8 files changed, 10 insertions(+), 27 deletions(-)

diff --git a/app/src/main/java/com/fredhappyface/ewesticker/StickerImporter.kt b/app/src/main/java/com/fredhappyface/ewesticker/StickerImporter.kt
index 7400f66..32a56a1 100644
--- a/app/src/main/java/com/fredhappyface/ewesticker/StickerImporter.kt
+++ b/app/src/main/java/com/fredhappyface/ewesticker/StickerImporter.kt
@@ -29,10 +29,10 @@ class StickerImporter(
 
 	/**
 	 * Used by the ACTION_OPEN_DOCUMENT_TREE handler function to copy stickers from a
-	 * stickerDirPath to the appplication internal storage for access later on by the
+	 * stickerDirPath to the application internal storage for access later on by the
 	 * keyboard
 	 *
-	 * @param stickerDirPath a URI to the stikers directory to import into EweSticker
+	 * @param stickerDirPath a URI to the stickers directory to import into EweSticker
 	 */
 	fun importStickers(stickerDirPath: String): Int {
 		File(this.context.filesDir, "stickers").deleteRecursively()
diff --git a/app/src/main/java/com/fredhappyface/ewesticker/StickerSender.kt b/app/src/main/java/com/fredhappyface/ewesticker/StickerSender.kt
index 73c2cb4..fa09aa4 100644
--- a/app/src/main/java/com/fredhappyface/ewesticker/StickerSender.kt
+++ b/app/src/main/java/com/fredhappyface/ewesticker/StickerSender.kt
@@ -50,7 +50,9 @@ class StickerSender(
 			.filter { isCommitContentSupported(this.currentInputEditorInfo, it) }
 
 	/**
-	 * TODO
+	 * Start the process of sending a sticker when the sticker is tapped in the
+	 * keyboard. If the sticker type is not supported by the InputConnection then
+	 * doFallbackCommitContent, otherwise doCommitContent
 	 *
 	 * @param file
 	 */
diff --git a/app/src/main/res/values-v27/styles.xml b/app/src/main/res/values-v27/styles.xml
index 4db539d..b53e400 100644
--- a/app/src/main/res/values-v27/styles.xml
+++ b/app/src/main/res/values-v27/styles.xml
@@ -23,7 +23,5 @@
 		<item name="colorOnSurface">@color/fg</item>
 		<item name="shapeAppearanceMediumComponent">@style/ShapeAppearance.App.MediumComponent
 		</item>
-		<item name="snackbarStyle">@style/Widget.App.Snackbar</item>
-		<item name="snackbarTextViewStyle">@style/Widget.App.Snackbar.TextView</item>
 	</style>
 </resources>
\ No newline at end of file
diff --git a/app/src/main/res/values/styles.xml b/app/src/main/res/values/styles.xml
index c469dd9..f1c9de3 100644
--- a/app/src/main/res/values/styles.xml
+++ b/app/src/main/res/values/styles.xml
@@ -21,23 +21,6 @@
 		<item name="colorOnSurface">@color/fg</item>
 		<item name="shapeAppearanceMediumComponent">@style/ShapeAppearance.App.MediumComponent
 		</item>
-		<item name="snackbarStyle">@style/Widget.App.Snackbar</item>
-		<item name="snackbarTextViewStyle">@style/Widget.App.Snackbar.TextView</item>
-	</style>
-
-	<style name="Widget.App.Snackbar" parent="Widget.MaterialComponents.Snackbar">
-		<item name="materialThemeOverlay">@style/ThemeOverlay.App.Snackbar</item>
-		<item name="actionTextColorAlpha">1</item>
-	</style>
-
-	<style name="Widget.App.Snackbar.TextView" parent="Widget.MaterialComponents.Snackbar.TextView">
-		<item name="android:textColor">@color/onAccent</item>
-		<item name="android:textSize">@dimen/text_size_body</item>
-		<item name="android:fontFamily">@font/firasans</item>
-	</style>
-
-	<style name="ThemeOverlay.App.Snackbar" parent="">
-		<item name="colorOnSurface">@color/accent</item>
 	</style>
 
 	<style name="ShapeAppearance.App.MediumComponent" parent="ShapeAppearance.MaterialComponents.MediumComponent">
diff --git a/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-importer/import-stickers.md b/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-importer/import-stickers.md
index 6aa2798..8f5a190 100644
--- a/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-importer/import-stickers.md
+++ b/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-importer/import-stickers.md
@@ -5,7 +5,7 @@
 [androidJvm]\
 fun [importStickers](import-stickers.md)(stickerDirPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
 
-Used by the ACTION_OPEN_DOCUMENT_TREE handler function to copy stickers from a stickerDirPath to the appplication internal storage for access later on by the keyboard
+Used by the ACTION_OPEN_DOCUMENT_TREE handler function to copy stickers from a stickerDirPath to the application internal storage for access later on by the keyboard
 
 ## Parameters
 
@@ -13,4 +13,4 @@ androidJvm
 
 | | |
 |---|---|
-| stickerDirPath | a URI to the stikers directory to import into EweSticker |
+| stickerDirPath | a URI to the stickers directory to import into EweSticker |
diff --git a/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-importer/index.md b/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-importer/index.md
index b13e23c..4cb86f0 100644
--- a/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-importer/index.md
+++ b/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-importer/index.md
@@ -19,7 +19,7 @@ The StickerImporter class includes a helper function to import stickers from a u
 |---|---|
 | [fileWalk](file-walk.md) | [androidJvm]<br>private fun [fileWalk](file-walk.md)(rootNode: [DocumentFile](https://developer.android.com/reference/kotlin/androidx/documentfile/provider/DocumentFile.html)?): [MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)&lt;[DocumentFile](https://developer.android.com/reference/kotlin/androidx/documentfile/provider/DocumentFile.html)&gt;<br>Get a MutableSet of DocumentFiles from a root node |
 | [importSticker](import-sticker.md) | [androidJvm]<br>private fun [importSticker](import-sticker.md)(sticker: [DocumentFile](https://developer.android.com/reference/kotlin/androidx/documentfile/provider/DocumentFile.html))<br>Copies stickers from source to internal storage |
-| [importStickers](import-stickers.md) | [androidJvm]<br>fun [importStickers](import-stickers.md)(stickerDirPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>Used by the ACTION_OPEN_DOCUMENT_TREE handler function to copy stickers from a stickerDirPath to the appplication internal storage for access later on by the keyboard |
+| [importStickers](import-stickers.md) | [androidJvm]<br>fun [importStickers](import-stickers.md)(stickerDirPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>Used by the ACTION_OPEN_DOCUMENT_TREE handler function to copy stickers from a stickerDirPath to the application internal storage for access later on by the keyboard |
 
 ## Properties
 
diff --git a/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-sender/index.md b/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-sender/index.md
index 1b401a0..6c80b57 100644
--- a/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-sender/index.md
+++ b/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-sender/index.md
@@ -20,7 +20,7 @@ The StickerSender Class used to contain all of the methods used for sending a st
 | [doCommitContent](do-commit-content.md) | [androidJvm]<br>private fun [doCommitContent](do-commit-content.md)(mimeType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), file: [File](https://developer.android.com/reference/kotlin/java/io/File.html))<br>Send a sticker file to a InputConnectionCompat |
 | [doFallbackCommitContent](do-fallback-commit-content.md) | [androidJvm]<br>private suspend fun [doFallbackCommitContent](do-fallback-commit-content.md)(file: [File](https://developer.android.com/reference/kotlin/java/io/File.html))<br>In the event that a mimetype is unsupported by a InputConnectionCompat (looking at you, Signal) create a temporary png and send that. In the event that png is not supported, alert the user. |
 | [isCommitContentSupported](is-commit-content-supported.md) | [androidJvm]<br>private fun [isCommitContentSupported](is-commit-content-supported.md)(editorInfo: [EditorInfo](https://developer.android.com/reference/kotlin/android/view/inputmethod/EditorInfo.html)?, mimeType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>Check if the sticker is supported by the receiver |
-| [sendSticker](send-sticker.md) | [androidJvm]<br>fun [sendSticker](send-sticker.md)(file: [File](https://developer.android.com/reference/kotlin/java/io/File.html))<br>TODO |
+| [sendSticker](send-sticker.md) | [androidJvm]<br>fun [sendSticker](send-sticker.md)(file: [File](https://developer.android.com/reference/kotlin/java/io/File.html))<br>Start the process of sending a sticker when the sticker is tapped in the keyboard. If the sticker type is not supported by the InputConnection then doFallbackCommitContent, otherwise doCommitContent |
 
 ## Properties
 
diff --git a/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-sender/send-sticker.md b/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-sender/send-sticker.md
index 4599edf..f613181 100644
--- a/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-sender/send-sticker.md
+++ b/documentation/reference/app/com.fredhappyface.ewesticker/-sticker-sender/send-sticker.md
@@ -5,7 +5,7 @@
 [androidJvm]\
 fun [sendSticker](send-sticker.md)(file: [File](https://developer.android.com/reference/kotlin/java/io/File.html))
 
-TODO
+Start the process of sending a sticker when the sticker is tapped in the keyboard. If the sticker type is not supported by the InputConnection then doFallbackCommitContent, otherwise doCommitContent
 
 ## Parameters