Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
sureshg committed Jun 30, 2017
1 parent 70bb483 commit 07d3189
Show file tree
Hide file tree
Showing 25 changed files with 194 additions and 65 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[![version][release-svg]][release-url] [![changelog][cl-svg]][cl-url] [![build][travis-svg]][travis-url] [![api-doc][apidoc-svg]][apidoc-url] [![gitter][gitter-svg]][gitter-url] [![license][license-svg]][license-url] [![kotlin][kotlin-svg]][kotlin-url]

A starter template for my [kotlin][kotlin-url] projects using [Gradle Script Kotlin][gsk]!
A starter template for my [kotlin][kotlin-url] projects using [Gradle Kotlin DSL][kotlin-dsl]!

</div>

Expand All @@ -29,7 +29,7 @@
```
> The binary would be located at `build/libs/kotlin-starter`
Inorder to build a new version, change `appVersion` in the [gradle.properties](gradle.properties) or pass it to `./gradlew -q -PappVersion=1.2.0`
Inorder to build a new version, change `appVersion` in the [gradle.properties](gradle.properties) or pass it to `./gradlew -q -PappVersion=2.0.0`

* API Doc

Expand Down Expand Up @@ -63,10 +63,10 @@

### Examples

* Generating [AOT type-safe accessors][gsk-aot-doc] in kotlin,
* Generating [AOT type-safe accessors][kotlin-dsl-aot-doc] in kotlin,

```bash
$ ./gradlew gskGenerateAccessors
$ ./gradlew kotlinDslAccessorsSnapshot
```

* Other Tasks
Expand Down Expand Up @@ -102,15 +102,15 @@
[apidoc-url]: https://sureshg.github.io/kotlin-starter/
[apidoc-svg]: https://img.shields.io/badge/api--doc-latest-ff69b4.svg?style=flat-square

[cl-url]: https://github.com/sureshg/kotlin-starter/blob/master/CHANGELOG.md#120---2017-06-11
[cl-svg]: https://img.shields.io/badge/change--log-1.2.0-blue.svg?style=flat-square
[cl-url]: https://github.com/sureshg/kotlin-starter/blob/master/CHANGELOG.md#200---2017-06-29
[cl-svg]: https://img.shields.io/badge/change--log-2.0.0-blue.svg?style=flat-square

[release-url]: https://github.com/sureshg/kotlin-starter/releases/latest
[download-url]: https://github.com/sureshg/kotlin-starter/releases/download/1.2.0/kotlin-starter
[download-url]: https://github.com/sureshg/kotlin-starter/releases/download/2.0.0/kotlin-starter
[release-svg]: https://img.shields.io/github/release/sureshg/kotlin-starter.svg?style=flat-square

[execjar-url]: https://github.com/sureshg/kotlin-starter/releases/download/1.2.0/kotlin-starter.jar
[execjar-svg]: https://img.shields.io/badge/exec--jar-1.2.0-00BCD4.svg?style=flat-square
[execjar-url]: https://github.com/sureshg/kotlin-starter/releases/download/2.0.0/kotlin-starter.jar
[execjar-svg]: https://img.shields.io/badge/exec--jar-2.0.0-00BCD4.svg?style=flat-square

[license-url]: https://github.com/sureshg/kotlin-starter/blob/master/LICENSE
[license-svg]: https://img.shields.io/github/license/sureshg/kotlin-starter.svg?style=flat-square
Expand All @@ -131,10 +131,10 @@
[gitter-svg]: https://img.shields.io/gitter/room/sureshg/kotlin-starter.svg

[kotlin-url]: https://kotlinlang.org/
[kotlin-svg]: https://img.shields.io/badge/kotlin-1.1.2--2-green.svg?style=flat-square
[kotlin-svg]: https://img.shields.io/badge/kotlin-1.2--M1-green.svg?style=flat-square

[gsk]: https://github.com/gradle/gradle-script-kotlin
[gsk-aot-doc]: https://github.com/gradle/gradle-script-kotlin/releases/tag/v0.8.0
[kotlin-dsl]: https://github.com/gradle/kotlin-dsl
[kotlin-dsl-aot-doc]: https://github.com/gradle/kotlin-dsl/releases/tag/v0.8.0

[kotlin-slack-thread]: https://kotlinlang.slack.com/archives/gradle/p1488489798002208
[maven-google-mirror]: https://maven-central.storage.googleapis.com
Expand Down
14 changes: 14 additions & 0 deletions docs/alltypes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,20 @@ <h3>All Types</h3>
</tr>
<tr>
<td>
<a href="../io.sureshg/-interop/index.html">io.sureshg.Interop</a></td>
<td>
<p>Use @ParametersAreNonnullByDefault and all parameters and return types are never null unless explicitly annotated @Nullable.</p>
</td>
</tr>
<tr>
<td>
<a href="../io.sureshg/-interop/index.html">io.sureshg.Interop</a></td>
<td>
<p>Use @ParametersAreNonnullByDefault and all parameters and return types are never null unless explicitly annotated @Nullable.</p>
</td>
</tr>
<tr>
<td>
<a href="../io.sureshg.extn/-j-s-s-e-prop/index.html">io.sureshg.extn.JSSEProp</a></td>
<td>
<p>JSSE system properties for customization.</p>
Expand Down
52 changes: 52 additions & 0 deletions docs/index-outline.html
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,32 @@
</BODY>
</HTML>
</ul>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-interop/index.html"><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Interop</span></a></a><br/>
<ul>
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Module Contents</title>
<link rel="stylesheet" href="style.css">
</HEAD>
<BODY>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-interop/-init-.html"><span class="identifier">Interop</span><span class="symbol">(</span><span class="symbol">)</span></a></a><br/>
</BODY>
</HTML>
</ul>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-interop/index.html"><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Interop</span></a></a><br/>
<ul>
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Module Contents</title>
<link rel="stylesheet" href="style.css">
</HEAD>
<BODY>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-interop/-init-.html"><span class="identifier">Interop</span><span class="symbol">(</span><span class="symbol">)</span></a></a><br/>
</BODY>
</HTML>
</ul>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg.extn/-j-s-s-e-prop/index.html"><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">JSSEProp</span></a></a><br/>
<ul>
<HTML>
Expand Down Expand Up @@ -831,6 +857,32 @@
<link rel="stylesheet" href="style.css">
</HEAD>
<BODY>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-interop/index.html"><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Interop</span></a></a><br/>
<ul>
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Module Contents</title>
<link rel="stylesheet" href="style.css">
</HEAD>
<BODY>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-interop/-init-.html"><span class="identifier">Interop</span><span class="symbol">(</span><span class="symbol">)</span></a></a><br/>
</BODY>
</HTML>
</ul>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-interop/index.html"><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">Interop</span></a></a><br/>
<ul>
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>Module Contents</title>
<link rel="stylesheet" href="style.css">
</HEAD>
<BODY>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-interop/-init-.html"><span class="identifier">Interop</span><span class="symbol">(</span><span class="symbol">)</span></a></a><br/>
</BODY>
</HTML>
</ul>
<a href="/Users/sgopal1/code/kotlin/kotlin-starter/docs/index"><a href="io.sureshg/-ui-op/index.html"><span class="keyword">sealed</span> <span class="keyword">class </span><span class="identifier">UiOp</span></a></a><br/>
<ul>
<HTML>
Expand Down
10 changes: 6 additions & 4 deletions docs/io.sureshg.extn/-j-s-s-e-prop/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ <h1>JSSEProp</h1>
<code><span class="keyword">enum</span> <span class="keyword">class </span><span class="identifier">JSSEProp</span></code>
<p>JSSE system properties for customization.</p>
<h3>Parameters</h3>
<a name="prop"></a>
<code>prop</code> - property name<a name="desc"></a>
<code>desc</code> - Detailed description of the property<a name="system"></a>
<p><a name="prop"></a>
<code>prop</code> - property name</p>
<p><a name="desc"></a>
<code>desc</code> - Detailed description of the property</p>
<p><a name="system"></a>
<code>system</code> - indicate whether it's a System or Security property.
<a href="#">true</a> if it's customized by setting System property.
<a href="#">true</a> if it's customized by setting System property.</p>
<h3>Enum Values</h3>
<table>
<tbody>
Expand Down
10 changes: 6 additions & 4 deletions docs/io.sureshg.extn/-saving-trust-manager/-init-.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ <h1>&lt;init&gt;</h1>
<code><span class="identifier">SavingTrustManager</span><span class="symbol">(</span><span class="identifier" id="io.sureshg.extn.SavingTrustManager$<init>(javax.net.ssl.X509TrustManager, kotlin.Boolean)/tm">tm</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html"><span class="identifier">X509TrustManager</span></a><span class="symbol">, </span><span class="identifier" id="io.sureshg.extn.SavingTrustManager$<init>(javax.net.ssl.X509TrustManager, kotlin.Boolean)/validate">validate</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">)</span></code>
<p>An <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a> to save the server/client cert chains.</p>
<h3>Parameters</h3>
<a name="tm"></a>
<code>tm</code> - delegating <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a><a name="validate"></a>
<code>validate</code> - <a href="#">true</a> to validate certificate chains. It's enabled by default.<a name="tm"></a>
<code>tm</code> - <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a>
<p><a name="tm"></a>
<code>tm</code> - delegating <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a></p>
<p><a name="validate"></a>
<code>validate</code> - <a href="#">true</a> to validate certificate chains. It's enabled by default.</p>
<p><a name="tm"></a>
<code>tm</code> - <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a></p>
</BODY>
</HTML>
10 changes: 6 additions & 4 deletions docs/io.sureshg.extn/-saving-trust-manager/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ <h1>SavingTrustManager</h1>
<code><span class="keyword">class </span><span class="identifier">SavingTrustManager</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html"><span class="identifier">X509TrustManager</span></a></code>
<p>An <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a> to save the server/client cert chains.</p>
<h3>Parameters</h3>
<a name="tm"></a>
<code>tm</code> - delegating <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a><a name="validate"></a>
<code>validate</code> - <a href="#">true</a> to validate certificate chains. It's enabled by default.<a name="tm"></a>
<code>tm</code> - <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a>
<p><a name="tm"></a>
<code>tm</code> - delegating <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a></p>
<p><a name="validate"></a>
<code>validate</code> - <a href="#">true</a> to validate certificate chains. It's enabled by default.</p>
<p><a name="tm"></a>
<code>tm</code> - <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a></p>
<h3>Constructors</h3>
<table>
<tbody>
Expand Down
13 changes: 8 additions & 5 deletions docs/io.sureshg.extn/get-s-s-l-context.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,13 @@ <h1>getSSLContext</h1>
TrustManagers decide whether to allow connections and KeyManagers decide which key material
to use.</p>
<h3>Parameters</h3>
<a name="protocol"></a>
<code>protocol</code> - SSL context protocol<a name="keyManagers"></a>
<code>keyManagers</code> - <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509KeyManager.html">X509KeyManager</a> which manages your keystore<a name="trustManagers"></a>
<code>trustManagers</code> - <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a> which manages your trust store<a name="secureRandom"></a>
<code>secureRandom</code> - <a href="http://docs.oracle.com/javase/8/docs/api/java/security/SecureRandom.html">SecureRandom</a> instance.
<p><a name="protocol"></a>
<code>protocol</code> - SSL context protocol</p>
<p><a name="keyManagers"></a>
<code>keyManagers</code> - <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509KeyManager.html">X509KeyManager</a> which manages your keystore</p>
<p><a name="trustManagers"></a>
<code>trustManagers</code> - <a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html">X509TrustManager</a> which manages your trust store</p>
<p><a name="secureRandom"></a>
<code>secureRandom</code> - <a href="http://docs.oracle.com/javase/8/docs/api/java/security/SecureRandom.html">SecureRandom</a> instance.</p>
</BODY>
</HTML>
7 changes: 4 additions & 3 deletions docs/io.sureshg.extn/java.io.-file/to-key-store.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ <h1>toKeyStore</h1>
<code><span class="keyword">fun </span><a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html"><span class="identifier">File</span></a><span class="symbol">.</span><span class="identifier">toKeyStore</span><span class="symbol">(</span><span class="identifier" id="io.sureshg.extn$toKeyStore(java.io.File, kotlin.String, kotlin.CharArray)/type">type</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a>&nbsp;<span class="symbol">=</span>&nbsp;KeyStore.getDefaultType()<span class="symbol">, </span><span class="identifier" id="io.sureshg.extn$toKeyStore(java.io.File, kotlin.String, kotlin.CharArray)/storePasswd">storePasswd</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-array/index.html"><span class="identifier">CharArray</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html"><span class="identifier">KeyStore</span></a><span class="symbol">?</span></code>
<p>Returns a <a href="http://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html">KeyStore</a> instance by loading this keystore file.</p>
<h3>Parameters</h3>
<a name="type"></a>
<code>type</code> - <a href="../-key-store-type/index.html">KeyStoreType</a> string. By default it uses JDK default type.<a name="storePasswd"></a>
<code>storePasswd</code> - store password of the keystore.
<p><a name="type"></a>
<code>type</code> - <a href="../-key-store-type/index.html">KeyStoreType</a> string. By default it uses JDK default type.</p>
<p><a name="storePasswd"></a>
<code>storePasswd</code> - store password of the keystore.</p>
</BODY>
</HTML>
4 changes: 2 additions & 2 deletions docs/io.sureshg.extn/java.io.-file/to-p12-key-store.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h1>toP12KeyStore</h1>
<code><span class="keyword">fun </span><a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html"><span class="identifier">File</span></a><span class="symbol">.</span><span class="identifier">toP12KeyStore</span><span class="symbol">(</span><span class="identifier" id="io.sureshg.extn$toP12KeyStore(java.io.File, kotlin.CharArray)/storePasswd">storePasswd</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-array/index.html"><span class="identifier">CharArray</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html"><span class="identifier">KeyStore</span></a><span class="symbol">?</span></code>
<p>Returns a PKCS12 <a href="http://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html">KeyStore</a> instance by loading this keystore file.</p>
<h3>Parameters</h3>
<a name="storePasswd"></a>
<code>storePasswd</code> - store password of the keystore.
<p><a name="storePasswd"></a>
<code>storePasswd</code> - store password of the keystore.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ <h1>toPKCS12</h1>
<p>Returns a new <a href="../-key-store-type/-p-k-c-s12.html">PKCS12</a> keystore using this keystore entries.
Returns the same instance if it's already a <a href="../-key-store-type/-p-k-c-s12.html">PKCS12</a> one.</p>
<h3>Parameters</h3>
<a name="keyPasswd"></a>
<code>keyPasswd</code> - key entry password.
<p><a name="keyPasswd"></a>
<code>keyPasswd</code> - key entry password.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h1>signedBy</h1>
<code><span class="keyword">fun </span><a href="http://docs.oracle.com/javase/8/docs/api/java/security/cert/X509Certificate.html"><span class="identifier">X509Certificate</span></a><span class="symbol">.</span><span class="identifier">signedBy</span><span class="symbol">(</span><span class="identifier" id="io.sureshg.extn$signedBy(java.security.cert.X509Certificate, java.security.cert.X509Certificate)/ca">ca</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/security/cert/X509Certificate.html"><span class="identifier">X509Certificate</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code>
<p>Returns true if the certificate is signed by the given <a href="signed-by.html#io.sureshg.extn$signedBy(java.security.cert.X509Certificate, java.security.cert.X509Certificate)/ca">ca</a> cert., false otherwise.</p>
<h3>Parameters</h3>
<a name="ca"></a>
<code>ca</code> - <a href="http://docs.oracle.com/javase/8/docs/api/java/security/cert/X509Certificate.html">X509Certificate</a> CA cert.
<p><a name="ca"></a>
<code>ca</code> - <a href="http://docs.oracle.com/javase/8/docs/api/java/security/cert/X509Certificate.html">X509Certificate</a> CA cert.</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <h1>saving</h1>
<code><span class="keyword">fun </span><a href="http://docs.oracle.com/javase/8/docs/api/javax/net/ssl/X509TrustManager.html"><span class="identifier">X509TrustManager</span></a><span class="symbol">.</span><span class="identifier">saving</span><span class="symbol">(</span><span class="identifier" id="io.sureshg.extn$saving(javax.net.ssl.X509TrustManager, kotlin.Boolean)/validate">validate</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a>&nbsp;<span class="symbol">=</span>&nbsp;true<span class="symbol">)</span><span class="symbol">: </span><a href="../-saving-trust-manager/index.html"><span class="identifier">SavingTrustManager</span></a></code>
<p>Returns a <a href="../-saving-trust-manager/index.html">SavingTrustManager</a> for this trust manager.</p>
<h3>Parameters</h3>
<a name="validate"></a>
<code>validate</code> - <a href="#">true</a> to validate certificate chains. It's enabled by default.
<p><a name="validate"></a>
<code>validate</code> - <a href="#">true</a> to validate certificate chains. It's enabled by default.</p>
</BODY>
</HTML>
10 changes: 6 additions & 4 deletions docs/io.sureshg.extn/kotlin.-char-array/pbe-cipher.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ <h1>pbeCipher</h1>
<p>Returns <a href="http://docs.oracle.com/javase/8/docs/api/javax/crypto/Cipher.html">Cipher</a> instance for this char array password
with password-based encryption (PBE).</p>
<h3>Parameters</h3>
<a name="algo"></a>
<code>algo</code> - cipher algorithm<a name="params"></a>
<code>params</code> - cipher <a href="http://docs.oracle.com/javase/8/docs/api/java/security/AlgorithmParameters.html">AlgorithmParameters</a><a name="mode"></a>
<code>mode</code> - cipher mode ENCRYPT, DECRYPT, WRAP etc.
<p><a name="algo"></a>
<code>algo</code> - cipher algorithm</p>
<p><a name="params"></a>
<code>params</code> - cipher <a href="http://docs.oracle.com/javase/8/docs/api/java/security/AlgorithmParameters.html">AlgorithmParameters</a></p>
<p><a name="mode"></a>
<code>mode</code> - cipher mode ENCRYPT, DECRYPT, WRAP etc.</p>
</BODY>
</HTML>
Loading

0 comments on commit 07d3189

Please sign in to comment.