update docs + tutorial

Author: FredHappyface

CHANGELOG.md

@@ -19,6 +19,7 @@ patch-level version changes can be found in [commit messages](../../commits/mast
 - Update navbar theme (dark/light rather than the app accent colour)
 - Update dependencies
 - Update tutorial location to [Tutorials](/documentation/tutorials)
+- Update tutorial
 
 ## 20220128 - 2022/01/28
 

README.md

@@ -117,7 +117,7 @@ Android SDK. Additional information can be found at
 1. Open the F-Droid app
 2. Search for EweSticker
 
-**Or**
+or
 
 [<img src="readme-assets/badges/f-droid-download.png"
 alt="Get it on F-Droid" height="80">](https://f-droid.org/en/packages/com.fredhappyface.ewesticker/)
@@ -130,7 +130,7 @@ then download/ install
 1. Open the Google Play app
 2. Search for EweSticker
 
-**Or**
+or
 
 [<img src="readme-assets/badges/google-play-download.png"
 alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/details?id=com.fredhappyface.ewesticker)
@@ -144,7 +144,7 @@ then download/ install
 2. Select the debug or release APK depending on your preference. Note that the
 filenames are in the form: com.fredhappyface.ewesticker-(version)-(debug|release).apk
 
-**Or**
+or
 
 [<img src="readme-assets/badges/direct-apk-download.png" alt="Direct apk
 download" height="80">](../../releases)

app/build.gradle.kts

@@ -13,6 +13,7 @@ tasks.dokkaGfm.configure {
 			skipEmptyPackages.set(true)
 			sourceRoots.from(file("src/main/java"))
 			suppressInheritedMembers.set(true)
+			includeNonPublic.set(true)
 		}
 	}
 }

app/src/main/AndroidManifest.xml

@@ -8,7 +8,9 @@
 		android:label="@string/app_name"
 		android:theme="@style/AppTheme"
 		tools:ignore="GoogleAppIndexingWarning"
-		android:dataExtractionRules="@xml/data_extraction_rules" tools:targetApi="s">
+		android:dataExtractionRules="@xml/data_extraction_rules"
+		android:fullBackupContent="@xml/full_backup_content"
+		tools:targetApi="s">
 		<activity
 			android:name="com.fredhappyface.ewesticker.MainActivity"
 			android:configChanges="keyboard|keyboardHidden|orientation|screenSize"

app/src/main/java/com/fredhappyface/ewesticker/StickerImporter.kt

@@ -10,10 +10,13 @@ private const val MAX_FILES = 4096
 private const val MAX_PACK_SIZE = 128
 
 /**
- * TODO
+ * The StickerImporter class includes a helper function to import stickers from a user-selected
+ * stickerDirPath (see importStickers). The class requires the application baseContext and an
+ * instance of Toaster (in turn requiring the application baseContext)
  *
- * @property context
- * @property toaster
+ * @property context: application baseContext
+ * @property toaster: an instance of Toaster (used to store an error state for later reporting to the
+ * user)
  */
 class StickerImporter(
 	private val context: Context,
@@ -25,9 +28,11 @@ class StickerImporter(
 	private var totalStickers = 0
 
 	/**
-	 * TODO
+	 * 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
 	 *
-	 * @param stickerDirPath
+	 * @param stickerDirPath a URI to the stikers directory to import into EweSticker
 	 */
 	fun importStickers(stickerDirPath: String): Int {
 		File(this.context.filesDir, "stickers").deleteRecursively()

app/src/main/java/com/fredhappyface/ewesticker/StickerSender.kt

@@ -20,15 +20,20 @@ import java.io.FileOutputStream
 import java.io.IOException
 
 /**
- * TODO
+ * The StickerSender Class used to contain all of the methods used for sending a sticker to an
+ * InputConnection
  *
- * @property context
- * @property toaster
- * @property internalDir
- * @property currentInputConnection
- * @property currentInputEditorInfo
- * @property compatCache
- * @property imageLoader
+ * @property context: application baseContext
+ * @property toaster: an instance of Toaster (used to store an error state for later reporting to the
+ * user)
+ * @property internalDir: the internal /stickers directory used when creating a compat sticker
+ * @property currentInputConnection: the currentInputConnection. i.e. the input field that the
+ * keyboard is going to send a sticker to
+ * @property currentInputEditorInfo: currentInputEditorInfo. i.e. info on the input field that the
+ * keyboard is going to send a sticker to
+ * @property compatCache: used to track previous x converted compat stickers
+ * @property imageLoader: coil imageLoader object used to convert a sticker file to a drawable ready
+ * for writing to a compat sticker
  */
 class StickerSender(
 	private val context: Context,

app/src/main/res/xml/data_extraction_rules.xml

@@ -7,7 +7,6 @@
 <data-extraction-rules>
     <cloud-backup>
         <!--
-        TODO: Use <include> and <exclude> to control what is backed up.
         The domain can be file, database, sharedpref, external or root.
         Examples:
 
@@ -33,4 +32,4 @@
         <exclude .../>
     </device-transfer>
     -->
-</data-extraction-rules>
+</data-extraction-rules>

app/src/main/res/xml/full_backup_content.xml

@@ -0,0 +1,2 @@
+<full-backup-content>
+</full-backup-content>

documentation/reference/app/com.fredhappyface.ewesticker/-cache/data.md

@@ -0,0 +1,6 @@
+//[app](../../../index.md)/[com.fredhappyface.ewesticker](../index.md)/[Cache](index.md)/[data](data.md)
+
+# data
+
+[androidJvm]\
+private var [data](data.md): [LinkedList](https://developer.android.com/reference/kotlin/java/util/LinkedList.html)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>

documentation/reference/app/com.fredhappyface.ewesticker/-cache/index.md

@@ -22,3 +22,10 @@ Basically this behaved like an ordered set with some maximum capacity. When this
 | [get](get.md) | [androidJvm]<br>fun [get](get.md)(idx: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html))<br>Get an element |
 | [toFiles](to-files.md) | [androidJvm]<br>fun [toFiles](to-files.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)&lt;[File](https://developer.android.com/reference/kotlin/java/io/File.html)&gt;<br>convert this to a array of files |
 | [toSharedPref](to-shared-pref.md) | [androidJvm]<br>fun [toSharedPref](to-shared-pref.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>convert this to a string to write to shared-pref |
+
+## Properties
+
+| Name | Summary |
+|---|---|
+| [data](data.md) | [androidJvm]<br>private var [data](data.md): [LinkedList](https://developer.android.com/reference/kotlin/java/util/LinkedList.html)&lt;[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)&gt; |
+| [size](size.md) | [androidJvm]<br>private val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) = 30 |