Cleanup and docsv1.0.1

4 files changed, 10 insertions, 1 deletions

diff --git a/app/src/main/kotlin/com/pitchedapps/frost/injectors/CssHider.kt b/app/src/main/kotlin/com/pitchedapps/frost/injectors/CssHider.kt
index 655da3ff..a83e87dc 100644
--- a/app/src/main/kotlin/com/pitchedapps/frost/injectors/CssHider.kt
+++ b/app/src/main/kotlin/com/pitchedapps/frost/injectors/CssHider.kt
@@ -5,6 +5,8 @@ import com.pitchedapps.frost.utils.L
 
 /**
  * Created by Allan Wang on 2017-05-31.
+ *
+ * List of elements to hide
  */
 enum class CssHider(vararg val items: String) : InjectorContract {
     CORE("[data-sigil=m_login_upsell]"),
diff --git a/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsActions.kt b/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsActions.kt
index 70df1bfa..4c44c1bf 100644
--- a/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsActions.kt
+++ b/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsActions.kt
@@ -5,6 +5,8 @@ import com.pitchedapps.frost.facebook.FB_URL_BASE
 
 /**
  * Created by Allan Wang on 2017-05-31.
+ *
+ * Collection of short js functions that are embedded directly
  */
 enum class JsActions(body: String) : InjectorContract {
     /**
diff --git a/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsAssets.kt b/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsAssets.kt
index 3ef1430d..132d1968 100644
--- a/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsAssets.kt
+++ b/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsAssets.kt
@@ -7,7 +7,6 @@ import com.pitchedapps.frost.utils.L
  * Created by Allan Wang on 2017-05-31.
  * Mapping of the available assets
  * The enum name must match the css file name
- * //TODO add folder mapping using Prefs
  */
 enum class JsAssets : InjectorContract {
     MENU, CLICK_A, CLICK_INTERCEPTOR, HEADER_BADGES, SEARCH
diff --git a/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsInjector.kt b/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsInjector.kt
index deb6c0be..1f35464b 100644
--- a/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsInjector.kt
+++ b/app/src/main/kotlin/com/pitchedapps/frost/injectors/JsInjector.kt
@@ -34,6 +34,9 @@ class JsBuilder {
     }
 }
 
+/**
+ * Contract for all injectors to allow it to interact properly with a webview
+ */
 interface InjectorContract {
     fun inject(webView: WebView) = inject(webView, null)
     fun inject(webView: WebView, callback: ((String) -> Unit)?)
@@ -58,6 +61,9 @@ fun WebView.jsInject(vararg injectors: InjectorContract, callback: ((Array<Strin
 
 fun FrostWebViewClient.jsInject(vararg injectors: InjectorContract, callback: ((Array<String>) -> Unit) = {}) = webCore.jsInject(*injectors, callback = callback)
 
+/**
+ * Wrapper class to convert a function into an injector
+ */
 class JsInjector(val function: String) : InjectorContract {
     override fun inject(webView: WebView, callback: ((String) -> Unit)?) {
         webView.evaluateJavascript(function, { value -> callback?.invoke(value) })