From 34631c72e2e01eba3f36ab81906f53d50bde7c9c Mon Sep 17 00:00:00 2001 From: Suresh G Date: Wed, 26 Apr 2017 02:27:43 -0700 Subject: [PATCH] Polish --- build.gradle.kts | 58 ++-- buildSrc/src/main/kotlin/Extensions.kt | 13 +- docs/alltypes/index.html | 27 -- docs/alltypes/index.md | 29 ++ docs/index-outline.html | 151 ----------- docs/index.html | 60 ----- docs/index.md | 88 ++++++ docs/index.yml | 74 ++++++ docs/io.sureshg/-java-main/-init-.html | 16 -- docs/io.sureshg/-java-main/-init-.md | 16 ++ docs/io.sureshg/-java-main/index.html | 40 --- docs/io.sureshg/-java-main/index.md | 50 ++++ docs/io.sureshg/-java-main/main.html | 14 - docs/io.sureshg/-java-main/main.md | 10 + docs/io.sureshg/-ui-op/-custom/-init-.html | 13 - docs/io.sureshg/-ui-op/-custom/-init-.md | 10 + docs/io.sureshg/-ui-op/-custom/index.html | 46 ---- docs/io.sureshg/-ui-op/-custom/index.md | 58 ++++ docs/io.sureshg/-ui-op/-custom/type.html | 14 - docs/io.sureshg/-ui-op/-custom/type.md | 10 + docs/io.sureshg/-ui-op/hide.html | 24 -- docs/io.sureshg/-ui-op/hide.md | 26 ++ docs/io.sureshg/-ui-op/index.html | 70 ----- docs/io.sureshg/-ui-op/index.md | 94 +++++++ docs/io.sureshg/-ui-op/name.html | 14 - docs/io.sureshg/-ui-op/name.md | 10 + docs/io.sureshg/-ui-op/show.html | 24 -- docs/io.sureshg/-ui-op/show.md | 26 ++ docs/io.sureshg/-user/-init-.html | 13 - docs/io.sureshg/-user/-init-.md | 10 + docs/io.sureshg/-user/index.html | 35 --- docs/io.sureshg/-user/index.md | 42 +++ docs/io.sureshg/-user/name.html | 14 - docs/io.sureshg/-user/name.md | 10 + docs/io.sureshg/any-or-nothing.html | 14 - docs/io.sureshg/any-or-nothing.md | 10 + docs/io.sureshg/explosive-place-holder.html | 15 -- docs/io.sureshg/explosive-place-holder.md | 13 + docs/io.sureshg/index.html | 78 ------ docs/io.sureshg/index.md | 107 ++++++++ docs/io.sureshg/join.html | 16 -- docs/io.sureshg/join.md | 13 + docs/io.sureshg/main.html | 24 -- docs/io.sureshg/main.md | 30 +++ docs/io.sureshg/sem-validation.html | 14 - docs/io.sureshg/sem-validation.md | 10 + docs/style.css | 280 -------------------- 47 files changed, 783 insertions(+), 1050 deletions(-) delete mode 100644 docs/alltypes/index.html create mode 100644 docs/alltypes/index.md delete mode 100644 docs/index-outline.html delete mode 100644 docs/index.html create mode 100644 docs/index.md create mode 100644 docs/index.yml delete mode 100644 docs/io.sureshg/-java-main/-init-.html create mode 100644 docs/io.sureshg/-java-main/-init-.md delete mode 100644 docs/io.sureshg/-java-main/index.html create mode 100644 docs/io.sureshg/-java-main/index.md delete mode 100644 docs/io.sureshg/-java-main/main.html create mode 100644 docs/io.sureshg/-java-main/main.md delete mode 100644 docs/io.sureshg/-ui-op/-custom/-init-.html create mode 100644 docs/io.sureshg/-ui-op/-custom/-init-.md delete mode 100644 docs/io.sureshg/-ui-op/-custom/index.html create mode 100644 docs/io.sureshg/-ui-op/-custom/index.md delete mode 100644 docs/io.sureshg/-ui-op/-custom/type.html create mode 100644 docs/io.sureshg/-ui-op/-custom/type.md delete mode 100644 docs/io.sureshg/-ui-op/hide.html create mode 100644 docs/io.sureshg/-ui-op/hide.md delete mode 100644 docs/io.sureshg/-ui-op/index.html create mode 100644 docs/io.sureshg/-ui-op/index.md delete mode 100644 docs/io.sureshg/-ui-op/name.html create mode 100644 docs/io.sureshg/-ui-op/name.md delete mode 100644 docs/io.sureshg/-ui-op/show.html create mode 100644 docs/io.sureshg/-ui-op/show.md delete mode 100644 docs/io.sureshg/-user/-init-.html create mode 100644 docs/io.sureshg/-user/-init-.md delete mode 100644 docs/io.sureshg/-user/index.html create mode 100644 docs/io.sureshg/-user/index.md delete mode 100644 docs/io.sureshg/-user/name.html create mode 100644 docs/io.sureshg/-user/name.md delete mode 100644 docs/io.sureshg/any-or-nothing.html create mode 100644 docs/io.sureshg/any-or-nothing.md delete mode 100644 docs/io.sureshg/explosive-place-holder.html create mode 100644 docs/io.sureshg/explosive-place-holder.md delete mode 100644 docs/io.sureshg/index.html create mode 100644 docs/io.sureshg/index.md delete mode 100644 docs/io.sureshg/join.html create mode 100644 docs/io.sureshg/join.md delete mode 100644 docs/io.sureshg/main.html create mode 100644 docs/io.sureshg/main.md delete mode 100644 docs/io.sureshg/sem-validation.html create mode 100644 docs/io.sureshg/sem-validation.md delete mode 100644 docs/style.css diff --git a/build.gradle.kts b/build.gradle.kts index d5f0d25..5f1ea9b 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -119,34 +119,6 @@ kotlin { experimental.coroutines = ENABLE } -/** - * Enable dokka task. - */ -tasks.withType { - val src = "src/main/kotlin" - val out = "$projectDir/docs" - doFirst { - println("Cleaning ${out.bold} directory...".cyan) - project.delete(out) - } - - moduleName = "" - outputFormat = DokkaFormat.html.name - outputDirectory = out - includes = listOf("README.md") - val mapping = LinkMapping().apply { - dir = src - url = "https://github.com/sureshg/kotlin-starter/blob/master/$src" - suffix = "#L" - } - linkMappings = arrayListOf(mapping) - description = "Generate docs in $outputFormat format." - - doLast { - println("Generated $outputFormat format docs to ${outputDirectory.bold}".done) - } -} - /** * Enable java incremental compilation. */ @@ -259,6 +231,36 @@ task("makeExecutable") { } +/** + * Generate doc using dokka. + */ +tasks.withType { + val src = "src/main/kotlin" + val out = "$projectDir/docs" + val format = DokkaFormat.KotlinWeb + doFirst { + println("Cleaning ${out.bold} directory...".cyan) + project.delete(out) + } + + moduleName = "" + outputFormat = format.type + outputDirectory = out + jdkVersion = javaVersion.majorVersion.toInt() + includes = listOf("README.md") + val mapping = LinkMapping().apply { + dir = src + url = "https://github.com/sureshg/kotlin-starter/blob/master/$src" + suffix = "#L" + } + linkMappings = arrayListOf(mapping) + description = "Generate docs in ${format.desc} format." + + doLast { + println("Generated ${format.desc} format docs to ${outputDirectory.bold}".done) + } +} + /** * Generate Gradle Script Kotlin wrapper. */ diff --git a/buildSrc/src/main/kotlin/Extensions.kt b/buildSrc/src/main/kotlin/Extensions.kt index 8931b2b..1b3c07a 100644 --- a/buildSrc/src/main/kotlin/Extensions.kt +++ b/buildSrc/src/main/kotlin/Extensions.kt @@ -59,10 +59,11 @@ fun Project.printHeader(version: Any?, embdKtVersion: String = embeddedKotlinVer /** * Dokka output format. */ -enum class DokkaFormat(val desc: String) { - html("HTML Doc"), - markdown("Markdown(md) doc"), - gfm("GitHub-Flavored Markdown"), - jekyll("Markdown adapted for Jekyll sites"), - javadoc("Javadoc format") +enum class DokkaFormat(val type: String, val desc: String) { + Html("html", "HTML Doc"), + KotlinWeb("kotlin-website", "Kotlin Website"), + Markdown("markdown", "Markdown(md) doc"), + Gfm("gfm", "GitHub-Flavored Markdown"), + Jekyll("jekyll", "Markdown adapted for Jekyll sites"), + JavaDoc("javadoc", "Javadoc format") } \ No newline at end of file diff --git a/docs/alltypes/index.html b/docs/alltypes/index.html deleted file mode 100644 index 12db8e0..0000000 --- a/docs/alltypes/index.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -alltypes - - - - -: -

All Types

- - - - - - - - - - - -
-io.sureshg.UiOp -
-io.sureshg.User -
- - diff --git a/docs/alltypes/index.md b/docs/alltypes/index.md new file mode 100644 index 0000000..e87ced7 --- /dev/null +++ b/docs/alltypes/index.md @@ -0,0 +1,29 @@ +--- +title: alltypes - +layout: api +--- + +: + +### All Types + + + + + + + + + + + + +
+io.sureshg.UiOp + + +
+io.sureshg.User + + +
diff --git a/docs/index-outline.html b/docs/index-outline.html deleted file mode 100644 index ca41afc..0000000 --- a/docs/index-outline.html +++ /dev/null @@ -1,151 +0,0 @@ - - - -Module Contents - - - -
- - - diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 157cc8e..0000000 --- a/docs/index.html +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - -
-
-:rocket:Kotlin Starter Project -

A starter template for my kotlin projects using Gradle Script Kotlin!

-
  • -

    Build

    -
      $ ./gradlew makeExecutable -q
    • -
  • -

    Generating AOT type-safe accessors in kotlin,

    -
      $ ./gradlew gskGenerateAccessors
    • -
  • -

    Other Tasks

    -
      # Run the main class.
-  $ ./gradlew clean :run
-  
-  # Display project dependency
-  $ ./gradlew dependencyInsight --dependency kotlin-stdlib  --configuration compile
-  $ ./gradlew dependencies
-  
-  # See task tree for build task
-  $ ./gradlew :build :taskTree
    • -
  • -

    Another way to configure coroutine

    -
       configure<KotlinProjectExtension> {
-        experimental.coroutines = ENABLE
-    }
    • -
-

Maven Google Mirror

-
maven { setUrl("https://maven-central.storage.googleapis.com") }
-

Kotlin Build Script Compilation

-

Script compilation happens in 4 steps:

-
  1. Extract buildscript block, compile it against parent project - classpath (up to buildSrc), evaluate it against current project.
    2. -
  2. Extract plugins block, compile it against the same classpath as - the previous step, evaluate it against current project.
    3. -
  3. MAGIC (generate Kotlin code based on information contributed by previous steps).
    4. -
  4. Compile whole script against classpath contributed by previous steps.
    5. -
-

Packages

- - - - - - - -
-io.sureshg -
-

Index

-All Types - - diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..f55eeb1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,88 @@ +--- +title: +layout: api +--- + + + +:rocket:Kotlin Starter Project + +A starter template for my kotlin projects using Gradle Script Kotlin! + +* + +Build + +``` bash + $ ./gradlew makeExecutable -q +``` + +* + +Generating AOT type-safe accessors in kotlin, + +``` bash + $ ./gradlew gskGenerateAccessors +``` + +* + +Other Tasks + +``` bash + # Run the main class. + $ ./gradlew clean :run + + # Display project dependency + $ ./gradlew dependencyInsight --dependency kotlin-stdlib --configuration compile + $ ./gradlew dependencies + + # See task tree for build task + $ ./gradlew :build :taskTree +``` + +* + +Another way to configure coroutine + +``` kotlin + configure { + experimental.coroutines = ENABLE + } +``` + +#### Maven Google Mirror + +``` kotlin +maven { setUrl("https://maven-central.storage.googleapis.com") } +``` + +#### Kotlin Build Script Compilation + +Script compilation happens in 4 steps: + +1. Extract buildscript block, compile it against parent project + classpath (up to buildSrc), evaluate it against current project. +1. Extract plugins block, compile it against the same classpath as + the previous step, evaluate it against current project. +1. MAGIC (generate Kotlin code based on information contributed by previous steps). +1. Compile whole script against classpath contributed by previous steps. + +### Packages + + + + + + + + +
+io.sureshg + + +
+ +### Index + +All Types \ No newline at end of file diff --git a/docs/index.yml b/docs/index.yml new file mode 100644 index 0000000..00587d9 --- /dev/null +++ b/docs/index.yml @@ -0,0 +1,74 @@ +- title: + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/index + content: + - title: alltypes + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/alltypes/index + content: + - title: UiOp + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/index + content: + - title: Custom + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/-custom/index + content: + - title: Custom + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/-custom/-init- + - title: type + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/-custom/type + - title: hide + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/hide + - title: name + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/name + - title: show + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/show + - title: User + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-user/index + content: + - title: User + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-user/-init- + - title: name + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-user/name + - title: io.sureshg + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/index + content: + - title: JavaMain + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-java-main/index + content: + - title: JavaMain + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-java-main/-init- + - title: main + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-java-main/main + - title: UiOp + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/index + content: + - title: Custom + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/-custom/index + content: + - title: Custom + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/-custom/-init- + - title: type + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/-custom/type + - title: hide + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/hide + - title: name + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/name + - title: show + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-ui-op/show + - title: User + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-user/index + content: + - title: User + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-user/-init- + - title: name + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/-user/name + - title: anyOrNothing + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/any-or-nothing + - title: explosivePlaceHolder + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/explosive-place-holder + - title: join + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/join + - title: main + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/main + - title: main + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/main + - title: semValidation + url: /Users/sgopal1/code/kotlin/kotlin-starter/docs/io.sureshg/sem-validation diff --git a/docs/io.sureshg/-java-main/-init-.html b/docs/io.sureshg/-java-main/-init-.html deleted file mode 100644 index b6b58c1..0000000 --- a/docs/io.sureshg/-java-main/-init-.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -JavaMain.<init> - - - - -io.sureshg / JavaMain / <init>
-
-

<init>

-JavaMain() -

Java class.

-

Author
-Suresh G (@sur3shg)

- - diff --git a/docs/io.sureshg/-java-main/-init-.md b/docs/io.sureshg/-java-main/-init-.md new file mode 100644 index 0000000..472944d --- /dev/null +++ b/docs/io.sureshg/-java-main/-init-.md @@ -0,0 +1,16 @@ +--- +title: JavaMain. - +layout: api +--- + +
io.sureshg / JavaMain / <init>
+ +# <init> + +
JavaMain()
+ +Java class. + +**Author** +Suresh G (@sur3shg) + diff --git a/docs/io.sureshg/-java-main/index.html b/docs/io.sureshg/-java-main/index.html deleted file mode 100644 index 863ae8e..0000000 --- a/docs/io.sureshg/-java-main/index.html +++ /dev/null @@ -1,40 +0,0 @@ - - - -JavaMain - - - - -io.sureshg / JavaMain
-
-

JavaMain

-open class JavaMain -

Java class.

-

Author
-Suresh G (@sur3shg)

-

Constructors

- - - - - - - -
-<init> -JavaMain() -

Java class.

-
-

Functions

- - - - - - - -
-main -open static fun main(args: Array<String>): Unit
- - diff --git a/docs/io.sureshg/-java-main/index.md b/docs/io.sureshg/-java-main/index.md new file mode 100644 index 0000000..42de3af --- /dev/null +++ b/docs/io.sureshg/-java-main/index.md @@ -0,0 +1,50 @@ +--- +title: JavaMain - +layout: api +--- + +
io.sureshg / JavaMain
+ +# JavaMain + +
open class JavaMain
+ +Java class. + +**Author** +Suresh G (@sur3shg) + +### Constructors + + + + + + + + +
+<init> + +
JavaMain()
+ +Java class. + + +
+ +### Functions + + + + + + + + +
+main + +
open static fun main(args: Array<String>): Unit
+ +
diff --git a/docs/io.sureshg/-java-main/main.html b/docs/io.sureshg/-java-main/main.html deleted file mode 100644 index 6698164..0000000 --- a/docs/io.sureshg/-java-main/main.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -JavaMain.main - - - - -io.sureshg / JavaMain / main
-
-

main

- -open static fun main(args: Array<String>): Unit - - diff --git a/docs/io.sureshg/-java-main/main.md b/docs/io.sureshg/-java-main/main.md new file mode 100644 index 0000000..dc8e6d3 --- /dev/null +++ b/docs/io.sureshg/-java-main/main.md @@ -0,0 +1,10 @@ +--- +title: JavaMain.main - +layout: api +--- + +
io.sureshg / JavaMain / main
+ +# main + +
open static fun main(args: Array<String>): Unit
diff --git a/docs/io.sureshg/-ui-op/-custom/-init-.html b/docs/io.sureshg/-ui-op/-custom/-init-.html deleted file mode 100644 index 427644b..0000000 --- a/docs/io.sureshg/-ui-op/-custom/-init-.html +++ /dev/null @@ -1,13 +0,0 @@ - - - -UiOp.Custom.<init> - - - - -io.sureshg / UiOp / Custom / <init>
-
-

<init>

-Custom(type: String) - - diff --git a/docs/io.sureshg/-ui-op/-custom/-init-.md b/docs/io.sureshg/-ui-op/-custom/-init-.md new file mode 100644 index 0000000..0b78809 --- /dev/null +++ b/docs/io.sureshg/-ui-op/-custom/-init-.md @@ -0,0 +1,10 @@ +--- +title: UiOp.Custom. - +layout: api +--- + +
io.sureshg / UiOp / Custom / <init>
+ +# <init> + +
Custom(type: String)
diff --git a/docs/io.sureshg/-ui-op/-custom/index.html b/docs/io.sureshg/-ui-op/-custom/index.html deleted file mode 100644 index 0098024..0000000 --- a/docs/io.sureshg/-ui-op/-custom/index.html +++ /dev/null @@ -1,46 +0,0 @@ - - - -UiOp.Custom - - - - -io.sureshg / UiOp / Custom
-
-

Custom

-data class Custom : UiOp (source) -

Constructors

- - - - - - - -
-<init> -Custom(type: String)
-

Properties

- - - - - - - -
-type -val type: String
-

Inherited Properties

- - - - - - - -
-name -val name: String
- - diff --git a/docs/io.sureshg/-ui-op/-custom/index.md b/docs/io.sureshg/-ui-op/-custom/index.md new file mode 100644 index 0000000..48c8850 --- /dev/null +++ b/docs/io.sureshg/-ui-op/-custom/index.md @@ -0,0 +1,58 @@ +--- +title: UiOp.Custom - +layout: api +--- + +
io.sureshg / UiOp / Custom
+ +# Custom + +
data class Custom : UiOp (source)
+ +### Constructors + + + + + + + + +
+<init> + +
Custom(type: String)
+ +
+ +### Properties + + + + + + + + +
+type + +
val type: String
+ +
+ +### Inherited Properties + + + + + + + + +
+name + +
val name: String
+ +
diff --git a/docs/io.sureshg/-ui-op/-custom/type.html b/docs/io.sureshg/-ui-op/-custom/type.html deleted file mode 100644 index 0d1a1f7..0000000 --- a/docs/io.sureshg/-ui-op/-custom/type.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -UiOp.Custom.type - - - - -io.sureshg / UiOp / Custom / type
-
-

type

- -val type: String (source) - - diff --git a/docs/io.sureshg/-ui-op/-custom/type.md b/docs/io.sureshg/-ui-op/-custom/type.md new file mode 100644 index 0000000..d117b04 --- /dev/null +++ b/docs/io.sureshg/-ui-op/-custom/type.md @@ -0,0 +1,10 @@ +--- +title: UiOp.Custom.type - +layout: api +--- + +
io.sureshg / UiOp / Custom / type
+ +# type + +
val type: String (source)
diff --git a/docs/io.sureshg/-ui-op/hide.html b/docs/io.sureshg/-ui-op/hide.html deleted file mode 100644 index c9fa1b8..0000000 --- a/docs/io.sureshg/-ui-op/hide.html +++ /dev/null @@ -1,24 +0,0 @@ - - - -UiOp.hide - - - - -io.sureshg / UiOp / hide
-
-

hide

-object hide : UiOp (source) -

Inherited Properties

- - - - - - - -
-name -val name: String
- - diff --git a/docs/io.sureshg/-ui-op/hide.md b/docs/io.sureshg/-ui-op/hide.md new file mode 100644 index 0000000..4047098 --- /dev/null +++ b/docs/io.sureshg/-ui-op/hide.md @@ -0,0 +1,26 @@ +--- +title: UiOp.hide - +layout: api +--- + +
io.sureshg / UiOp / hide
+ +# hide + +
object hide : UiOp (source)
+ +### Inherited Properties + + + + + + + + +
+name + +
val name: String
+ +
diff --git a/docs/io.sureshg/-ui-op/index.html b/docs/io.sureshg/-ui-op/index.html deleted file mode 100644 index a31905a..0000000 --- a/docs/io.sureshg/-ui-op/index.html +++ /dev/null @@ -1,70 +0,0 @@ - - - -UiOp - - - - -io.sureshg / UiOp
-
-

UiOp

-sealed class UiOp (source) -

Types

- - - - - - - - - - - - - - - -
-Custom -data class Custom : UiOp
-hide -object hide : UiOp
-show -object show : UiOp
-

Properties

- - - - - - - -
-name -val name: String
-

Inheritors

- - - - - - - - - - - - - - - -
-Custom -data class Custom : UiOp
-hide -object hide : UiOp
-show -object show : UiOp
- - diff --git a/docs/io.sureshg/-ui-op/index.md b/docs/io.sureshg/-ui-op/index.md new file mode 100644 index 0000000..ea9d543 --- /dev/null +++ b/docs/io.sureshg/-ui-op/index.md @@ -0,0 +1,94 @@ +--- +title: UiOp - +layout: api +--- + +
io.sureshg / UiOp
+ +# UiOp + +
sealed class UiOp (source)
+ +### Types + + + + + + + + + + + + + + + + +
+Custom + +
data class Custom : UiOp
+ +
+hide + +
object hide : UiOp
+ +
+show + +
object show : UiOp
+ +
+ +### Properties + + + + + + + + +
+name + +
val name: String
+ +
+ +### Inheritors + + + + + + + + + + + + + + + + +
+Custom + +
data class Custom : UiOp
+ +
+hide + +
object hide : UiOp
+ +
+show + +
object show : UiOp
+ +
diff --git a/docs/io.sureshg/-ui-op/name.html b/docs/io.sureshg/-ui-op/name.html deleted file mode 100644 index 80bd8f8..0000000 --- a/docs/io.sureshg/-ui-op/name.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -UiOp.name - - - - -io.sureshg / UiOp / name
-
-

name

- -val name: String (source) - - diff --git a/docs/io.sureshg/-ui-op/name.md b/docs/io.sureshg/-ui-op/name.md new file mode 100644 index 0000000..a82e950 --- /dev/null +++ b/docs/io.sureshg/-ui-op/name.md @@ -0,0 +1,10 @@ +--- +title: UiOp.name - +layout: api +--- + +
io.sureshg / UiOp / name
+ +# name + +
val name: String (source)
diff --git a/docs/io.sureshg/-ui-op/show.html b/docs/io.sureshg/-ui-op/show.html deleted file mode 100644 index 0c3c82c..0000000 --- a/docs/io.sureshg/-ui-op/show.html +++ /dev/null @@ -1,24 +0,0 @@ - - - -UiOp.show - - - - -io.sureshg / UiOp / show
-
-

show

-object show : UiOp (source) -

Inherited Properties

- - - - - - - -
-name -val name: String
- - diff --git a/docs/io.sureshg/-ui-op/show.md b/docs/io.sureshg/-ui-op/show.md new file mode 100644 index 0000000..b7548a4 --- /dev/null +++ b/docs/io.sureshg/-ui-op/show.md @@ -0,0 +1,26 @@ +--- +title: UiOp.show - +layout: api +--- + +
io.sureshg / UiOp / show
+ +# show + +
object show : UiOp (source)
+ +### Inherited Properties + + + + + + + + +
+name + +
val name: String
+ +
diff --git a/docs/io.sureshg/-user/-init-.html b/docs/io.sureshg/-user/-init-.html deleted file mode 100644 index 3712148..0000000 --- a/docs/io.sureshg/-user/-init-.html +++ /dev/null @@ -1,13 +0,0 @@ - - - -User.<init> - - - - -io.sureshg / User / <init>
-
-

<init>

-User(name: String) - - diff --git a/docs/io.sureshg/-user/-init-.md b/docs/io.sureshg/-user/-init-.md new file mode 100644 index 0000000..d6b66f8 --- /dev/null +++ b/docs/io.sureshg/-user/-init-.md @@ -0,0 +1,10 @@ +--- +title: User. - +layout: api +--- + +
io.sureshg / User / <init>
+ +# <init> + +
User(name: String)
diff --git a/docs/io.sureshg/-user/index.html b/docs/io.sureshg/-user/index.html deleted file mode 100644 index f7903e1..0000000 --- a/docs/io.sureshg/-user/index.html +++ /dev/null @@ -1,35 +0,0 @@ - - - -User - - - - -io.sureshg / User
-
-

User

-data class User (source) -

Constructors

- - - - - - - -
-<init> -User(name: String)
-

Properties

- - - - - - - -
-name -val name: String
- - diff --git a/docs/io.sureshg/-user/index.md b/docs/io.sureshg/-user/index.md new file mode 100644 index 0000000..4736748 --- /dev/null +++ b/docs/io.sureshg/-user/index.md @@ -0,0 +1,42 @@ +--- +title: User - +layout: api +--- + +
io.sureshg / User
+ +# User + +
data class User (source)
+ +### Constructors + + + + + + + + +
+<init> + +
User(name: String)
+ +
+ +### Properties + + + + + + + + +
+name + +
val name: String
+ +
diff --git a/docs/io.sureshg/-user/name.html b/docs/io.sureshg/-user/name.html deleted file mode 100644 index 0a54fe8..0000000 --- a/docs/io.sureshg/-user/name.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -User.name - - - - -io.sureshg / User / name
-
-

name

- -val name: String (source) - - diff --git a/docs/io.sureshg/-user/name.md b/docs/io.sureshg/-user/name.md new file mode 100644 index 0000000..8ea7cad --- /dev/null +++ b/docs/io.sureshg/-user/name.md @@ -0,0 +1,10 @@ +--- +title: User.name - +layout: api +--- + +
io.sureshg / User / name
+ +# name + +
val name: String (source)
diff --git a/docs/io.sureshg/any-or-nothing.html b/docs/io.sureshg/any-or-nothing.html deleted file mode 100644 index 6622aea..0000000 --- a/docs/io.sureshg/any-or-nothing.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -anyOrNothing - - - - -io.sureshg / anyOrNothing
-
-

anyOrNothing

- -fun anyOrNothing(user: User?): Unit (source) - - diff --git a/docs/io.sureshg/any-or-nothing.md b/docs/io.sureshg/any-or-nothing.md new file mode 100644 index 0000000..c56fa06 --- /dev/null +++ b/docs/io.sureshg/any-or-nothing.md @@ -0,0 +1,10 @@ +--- +title: anyOrNothing - +layout: api +--- + +
io.sureshg / anyOrNothing
+ +# anyOrNothing + +
fun anyOrNothing(user: User?): Unit (source)
diff --git a/docs/io.sureshg/explosive-place-holder.html b/docs/io.sureshg/explosive-place-holder.html deleted file mode 100644 index 5515160..0000000 --- a/docs/io.sureshg/explosive-place-holder.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -explosivePlaceHolder - - - - -io.sureshg / explosivePlaceHolder
-
-

explosivePlaceHolder

- -fun explosivePlaceHolder(): String (source) -

Kotlin explosive place holder.

- - diff --git a/docs/io.sureshg/explosive-place-holder.md b/docs/io.sureshg/explosive-place-holder.md new file mode 100644 index 0000000..3d2c8b3 --- /dev/null +++ b/docs/io.sureshg/explosive-place-holder.md @@ -0,0 +1,13 @@ +--- +title: explosivePlaceHolder - +layout: api +--- + +
io.sureshg / explosivePlaceHolder
+ +# explosivePlaceHolder + +
fun explosivePlaceHolder(): String (source)
+ +Kotlin explosive place holder. + diff --git a/docs/io.sureshg/index.html b/docs/io.sureshg/index.html deleted file mode 100644 index aa869e5..0000000 --- a/docs/io.sureshg/index.html +++ /dev/null @@ -1,78 +0,0 @@ - - - -io.sureshg - - - - -io.sureshg
-
-

Package io.sureshg

-

Types

- - - - - - - - - - - - - - - -
-JavaMain -open class JavaMain -

Java class.

-
-UiOp -sealed class UiOp
-User -data class User
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - -
-anyOrNothing -fun anyOrNothing(user: User?): Unit
-explosivePlaceHolder -fun explosivePlaceHolder(): String -

Kotlin explosive place holder.

-
-join -fun join(sep: String, strings: List<String>): String
-main -fun main(args: Array<String>): Unit -

Idiomatic kotlin

-fun main(args: Array<String>): Unit -

Kotlin class.

-
-semValidation -fun semValidation(msg: String): Unit
- - diff --git a/docs/io.sureshg/index.md b/docs/io.sureshg/index.md new file mode 100644 index 0000000..7b891fb --- /dev/null +++ b/docs/io.sureshg/index.md @@ -0,0 +1,107 @@ +--- +title: io.sureshg - +layout: api +--- + + + +## Package io.sureshg + +### Types + + + + + + + + + + + + + + + + +
+JavaMain + +
open class JavaMain
+ +Java class. + + +
+UiOp + +
sealed class UiOp
+ +
+User + +
data class User
+ +
+ +### Functions + + + + + + + + + + + + + + + + + + + + + + + + +
+anyOrNothing + +
fun anyOrNothing(user: User?): Unit
+ +
+explosivePlaceHolder + +
fun explosivePlaceHolder(): String
+ +Kotlin explosive place holder. + + +
+join + +
fun join(sep: String, strings: List<String>): String
+ +
+main + +
fun main(args: Array<String>): Unit
+ +Idiomatic kotlin + +
fun main(args: Array<String>): Unit
+ +Kotlin class. + + +
+semValidation + +
fun semValidation(msg: String): Unit
+ +
diff --git a/docs/io.sureshg/join.html b/docs/io.sureshg/join.html deleted file mode 100644 index e4d48a7..0000000 --- a/docs/io.sureshg/join.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -join - - - - -io.sureshg / join
-
-

join

- -fun join(sep: String, strings: List<String>): String (source)
-Deprecated: String strings.joinToString(sep).
-
- - diff --git a/docs/io.sureshg/join.md b/docs/io.sureshg/join.md new file mode 100644 index 0000000..56ccb51 --- /dev/null +++ b/docs/io.sureshg/join.md @@ -0,0 +1,13 @@ +--- +title: join - +layout: api +--- + +
io.sureshg / join
+ +# join + +
fun join(sep: String, strings: List<String>): String (source)
+ +**Deprecated:** String strings.joinToString(sep). + diff --git a/docs/io.sureshg/main.html b/docs/io.sureshg/main.html deleted file mode 100644 index a382203..0000000 --- a/docs/io.sureshg/main.html +++ /dev/null @@ -1,24 +0,0 @@ - - - -main - - - - -io.sureshg / main
-
-

main

- -

-fun main(args: Array<String>): Unit (source) -

Idiomatic kotlin

-

Author
-Suresh (@sur3shg)

- -

-fun main(args: Array<String>): Unit (source) -

Kotlin class.

-

Author
-Suresh G (@sur3shg)

- - diff --git a/docs/io.sureshg/main.md b/docs/io.sureshg/main.md new file mode 100644 index 0000000..b1dee8d --- /dev/null +++ b/docs/io.sureshg/main.md @@ -0,0 +1,30 @@ +--- +title: main - +layout: api +--- + +
io.sureshg / main
+ +# main + +
+ +
fun main(args: Array<String>): Unit (source)
+ +Idiomatic kotlin + +**Author** +Suresh (@sur3shg) + +
+ +
+ +
fun main(args: Array<String>): Unit (source)
+ +Kotlin class. + +**Author** +Suresh G (@sur3shg) + +
diff --git a/docs/io.sureshg/sem-validation.html b/docs/io.sureshg/sem-validation.html deleted file mode 100644 index 10daca8..0000000 --- a/docs/io.sureshg/sem-validation.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -semValidation - - - - -io.sureshg / semValidation
-
-

semValidation

- -fun semValidation(msg: String): Unit (source) - - diff --git a/docs/io.sureshg/sem-validation.md b/docs/io.sureshg/sem-validation.md new file mode 100644 index 0000000..c2e2ae0 --- /dev/null +++ b/docs/io.sureshg/sem-validation.md @@ -0,0 +1,10 @@ +--- +title: semValidation - +layout: api +--- + +
io.sureshg / semValidation
+ +# semValidation + +
fun semValidation(msg: String): Unit (source)
diff --git a/docs/style.css b/docs/style.css deleted file mode 100644 index 0958623..0000000 --- a/docs/style.css +++ /dev/null @@ -1,280 +0,0 @@ -@import url(https://fonts.googleapis.com/css?family=Lato:300italic,700italic,300,700); - -body, table { - padding:50px; - font:14px/1.5 Lato, "Helvetica Neue", Helvetica, Arial, sans-serif; - color:#555; - font-weight:300; -} - -.keyword { - color:black; - font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal; - font-size:12px; -} - -.symbol { - font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal; - font-size:12px; -} - -.identifier { - color: darkblue; - font-size:12px; - font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal; -} - -h1, h2, h3, h4, h5, h6 { - color:#222; - margin:0 0 20px; -} - -p, ul, ol, table, pre, dl { - margin:0 0 20px; -} - -h1, h2, h3 { - line-height:1.1; -} - -h1 { - font-size:28px; -} - -h2 { - color:#393939; -} - -h3, h4, h5, h6 { - color:#494949; -} - -a { - color:#258aaf; - font-weight:400; - text-decoration:none; -} - -a:hover { - color: inherit; - text-decoration:underline; -} - -a small { - font-size:11px; - color:#555; - margin-top:-0.6em; - display:block; -} - -.wrapper { - width:860px; - margin:0 auto; -} - -blockquote { - border-left:1px solid #e5e5e5; - margin:0; - padding:0 0 0 20px; - font-style:italic; -} - -code, pre { - font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal; - color:#333; - font-size:12px; -} - -pre { - display: block; -/* - padding:8px 8px; - background: #f8f8f8; - border-radius:5px; - border:1px solid #e5e5e5; -*/ - overflow-x: auto; -} - -table { - width:100%; - border-collapse:collapse; -} - -th, td { - text-align:left; - vertical-align: top; - padding:5px 10px; -} - -dt { - color:#444; - font-weight:700; -} - -th { - color:#444; -} - -img { - max-width:100%; -} - -header { - width:270px; - float:left; - position:fixed; -} - -header ul { - list-style:none; - height:40px; - - padding:0; - - background: #eee; - background: -moz-linear-gradient(top, #f8f8f8 0%, #dddddd 100%); - background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#f8f8f8), color-stop(100%,#dddddd)); - background: -webkit-linear-gradient(top, #f8f8f8 0%,#dddddd 100%); - background: -o-linear-gradient(top, #f8f8f8 0%,#dddddd 100%); - background: -ms-linear-gradient(top, #f8f8f8 0%,#dddddd 100%); - background: linear-gradient(top, #f8f8f8 0%,#dddddd 100%); - - border-radius:5px; - border:1px solid #d2d2d2; - box-shadow:inset #fff 0 1px 0, inset rgba(0,0,0,0.03) 0 -1px 0; - width:270px; -} - -header li { - width:89px; - float:left; - border-right:1px solid #d2d2d2; - height:40px; -} - -header ul a { - line-height:1; - font-size:11px; - color:#999; - display:block; - text-align:center; - padding-top:6px; - height:40px; -} - -strong { - color:#222; - font-weight:700; -} - -header ul li + li { - width:88px; - border-left:1px solid #fff; -} - -header ul li + li + li { - border-right:none; - width:89px; -} - -header ul a strong { - font-size:14px; - display:block; - color:#222; -} - -section { - width:500px; - float:right; - padding-bottom:50px; -} - -small { - font-size:11px; -} - -hr { - border:0; - background:#e5e5e5; - height:1px; - margin:0 0 20px; -} - -footer { - width:270px; - float:left; - position:fixed; - bottom:50px; -} - -@media print, screen and (max-width: 960px) { - - div.wrapper { - width:auto; - margin:0; - } - - header, section, footer { - float:none; - position:static; - width:auto; - } - - header { - padding-right:320px; - } - - section { - border:1px solid #e5e5e5; - border-width:1px 0; - padding:20px 0; - margin:0 0 20px; - } - - header a small { - display:inline; - } - - header ul { - position:absolute; - right:50px; - top:52px; - } -} - -@media print, screen and (max-width: 720px) { - body { - word-wrap:break-word; - } - - header { - padding:0; - } - - header ul, header p.view { - position:static; - } - - pre, code { - word-wrap:normal; - } -} - -@media print, screen and (max-width: 480px) { - body { - padding:15px; - } - - header ul { - display:none; - } -} - -@media print { - body { - padding:0.4in; - font-size:12pt; - color:#444; - } -}