Skip to content

Commit

Permalink
added javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
vikramezhil committed Apr 13, 2020
1 parent d4eb352 commit 1b3245e
Show file tree
Hide file tree
Showing 181 changed files with 5,475 additions and 20 deletions.
4 changes: 2 additions & 2 deletions DroidKotSpeech/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ buildscript {

}
dependencies {
classpath 'com.android.tools.build:gradle:3.6.1'
classpath 'com.android.tools.build:gradle:3.6.2'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.10.1"

// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
Expand All @@ -20,7 +21,6 @@ allprojects {
repositories {
google()
jcenter()

}
}

Expand Down
29 changes: 11 additions & 18 deletions DroidKotSpeech/dks/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ apply plugin: 'com.android.library'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'
apply plugin: 'org.jetbrains.dokka'

android {
compileSdkVersion 29
Expand Down Expand Up @@ -49,23 +50,15 @@ dependencies {
androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
}

task sourcesJar(type: Jar) {
from android.sourceSets.main.java.srcDirs
archiveClassifier.set("sources")
}

task javadoc(type: Javadoc) {
failOnError false
source = android.sourceSets.main.java.sourceFiles
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
}
dokka {
outputFormat = 'html'
outputDirectory = "$buildDir/javadoc"

task javadocJar(type: Jar, dependsOn: javadoc) {
archiveClassifier.set("javadoc")
from javadoc.destinationDir
}

artifacts {
archives sourcesJar
archives javadocJar
configuration {
includeNonPublic = false
skipEmptyPackages = true
skipDeprecated = true
reportUndocumented = true
jdkVersion = 8
}
}
77 changes: 77 additions & 0 deletions javadoc/dks/alltypes/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>alltypes - dks</title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<h3>All Types</h3>
<table>
<tbody>
<tr>
<h5><a href="../github.com.vikramezhil.dks.view.animation/-animation-engine/index.html">github.com.vikramezhil.dks.view.animation.AnimationEngine</a></h5>
<p>Animation Engine abstract</p>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.view.animation.bounce/-bounce-animation-driver/index.html">github.com.vikramezhil.dks.view.animation.bounce.BounceAnimationDriver</a></h5>
<p>Bounce Animation Driver</p>
</tr>
<tr>
(extensions in package github.com.vikramezhil.dks.utils)
<h5><a href="../github.com.vikramezhil.dks.utils/android.os.-bundle/index.html">android.os.Bundle</a></h5>
</tr>
<tr>
(extensions in package github.com.vikramezhil.dks.utils)
<h5><a href="../github.com.vikramezhil.dks.utils/android.content.-context/index.html">android.content.Context</a></h5>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.speech/-dks/index.html">github.com.vikramezhil.dks.speech.Dks</a></h5>
<p>Droid Kotlin Speech</p>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.speech/-dks-engine/index.html">github.com.vikramezhil.dks.speech.DksEngine</a></h5>
<p>Droid Kotlin Speech Engine abstract</p>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.view.alert/-dks-full-screen-dialog/index.html">github.com.vikramezhil.dks.view.alert.DksFullScreenDialog</a></h5>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.view.alert/-dks-full-screen-dialog-listener/index.html">github.com.vikramezhil.dks.view.alert.DksFullScreenDialogListener</a></h5>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.language/-dks-language-listener/index.html">github.com.vikramezhil.dks.language.DksLanguageListener</a></h5>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.language/-dks-language-receiver/index.html">github.com.vikramezhil.dks.language.DksLanguageReceiver</a></h5>
<p>Droid Kotlin Speech Language Receiver</p>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.speech/-dks-listener/index.html">github.com.vikramezhil.dks.speech.DksListener</a></h5>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.view.alert/-dks-live-observers/index.html">github.com.vikramezhil.dks.view.alert.DksLiveObservers</a></h5>
<p>Dks Full Screen Dialog</p>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.view.progress/-dks-progress-view/index.html">github.com.vikramezhil.dks.view.progress.DksProgressView</a></h5>
<p>Dks Progress View</p>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.view.progress/-dks-progress-view-listener/index.html">github.com.vikramezhil.dks.view.progress.DksProgressViewListener</a></h5>
</tr>
<tr>
(extensions in package github.com.vikramezhil.dks.utils)
<h5><a href="../github.com.vikramezhil.dks.utils/kotlin.-int/index.html">kotlin.Int</a></h5>
</tr>
<tr>
(extensions in package github.com.vikramezhil.dks.utils)
<h5><a href="../github.com.vikramezhil.dks.utils/kotlin.random.-random/index.html">kotlin.random.Random</a></h5>
</tr>
<tr>
<h5><a href="../github.com.vikramezhil.dks.utils/-speech-result/index.html">github.com.vikramezhil.dks.utils.SpeechResult</a></h5>
<p>Parser Extensions</p>
</tr>
</tbody>
</table>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksLanguageListener - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.language</a>&nbsp;/&nbsp;<a href="./index.html">DksLanguageListener</a><br/>
<br/>
<h1>DksLanguageListener</h1>
<code><span class="keyword">interface </span><span class="identifier">DksLanguageListener</span></code>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="on-dks-supported-languages.html">onDksSupportedLanguages</a></h4>
</td>
<td>
<p>Sends an update on the supported languages</p>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onDksSupportedLanguages</span><span class="symbol">(</span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageListener$onDksSupportedLanguages(kotlin.String, java.util.ArrayList((kotlin.String)))/defaultLanguage">defaultLanguage</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><span class="symbol">?</span><span class="symbol">, </span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageListener$onDksSupportedLanguages(kotlin.String, java.util.ArrayList((kotlin.String)))/supportedLanguages">supportedLanguages</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-array-list/index.html"><span class="identifier">ArrayList</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksLanguageListener.onDksSupportedLanguages - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.language</a>&nbsp;/&nbsp;<a href="index.html">DksLanguageListener</a>&nbsp;/&nbsp;<a href="./on-dks-supported-languages.html">onDksSupportedLanguages</a><br/>
<br/>
<h1>onDksSupportedLanguages</h1>
<a name="github.com.vikramezhil.dks.language.DksLanguageListener$onDksSupportedLanguages(kotlin.String, java.util.ArrayList((kotlin.String)))"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">onDksSupportedLanguages</span><span class="symbol">(</span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageListener$onDksSupportedLanguages(kotlin.String, java.util.ArrayList((kotlin.String)))/defaultLanguage">defaultLanguage</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><span class="symbol">?</span><span class="symbol">, </span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageListener$onDksSupportedLanguages(kotlin.String, java.util.ArrayList((kotlin.String)))/supportedLanguages">supportedLanguages</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-array-list/index.html"><span class="identifier">ArrayList</span></a><span class="symbol">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">&gt;</span><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Sends an update on the supported languages</p>
<h3>Parameters</h3>
<p><a name="defaultLanguage"></a>
<code>defaultLanguage</code> - String The current default language</p>
<p><a name="supportedLanguages"></a>
<code>supportedLanguages</code> - ArrayList The supported languages list</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksLanguageReceiver.<init> - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.language</a>&nbsp;/&nbsp;<a href="index.html">DksLanguageReceiver</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<a name="github.com.vikramezhil.dks.language.DksLanguageReceiver$&lt;init&gt;(github.com.vikramezhil.dks.language.DksLanguageListener)"></a>
<code><span class="identifier">DksLanguageReceiver</span><span class="symbol">(</span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageReceiver$<init>(github.com.vikramezhil.dks.language.DksLanguageListener)/listener">listener</span><span class="symbol">:</span>&nbsp;<a href="../-dks-language-listener/index.html"><span class="identifier">DksLanguageListener</span></a><span class="symbol">)</span></code>
<p>Droid Kotlin Speech Language Receiver</p>
<p><strong>Author</strong><br/>
vikramezhil</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksLanguageReceiver - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.language</a>&nbsp;/&nbsp;<a href="./index.html">DksLanguageReceiver</a><br/>
<br/>
<h1>DksLanguageReceiver</h1>
<code><span class="keyword">class </span><span class="identifier">DksLanguageReceiver</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/content/BroadcastReceiver.html"><span class="identifier">BroadcastReceiver</span></a></code>
<p>Droid Kotlin Speech Language Receiver</p>
<p><strong>Author</strong><br/>
vikramezhil</p>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="-init-.html">&lt;init&gt;</a></h4>
</td>
<td>
<p>Droid Kotlin Speech Language Receiver</p>
<code><span class="identifier">DksLanguageReceiver</span><span class="symbol">(</span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageReceiver$<init>(github.com.vikramezhil.dks.language.DksLanguageListener)/listener">listener</span><span class="symbol">:</span>&nbsp;<a href="../-dks-language-listener/index.html"><span class="identifier">DksLanguageListener</span></a><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="on-receive.html">onReceive</a></h4>
</td>
<td>
<code><span class="keyword">fun </span><span class="identifier">onReceive</span><span class="symbol">(</span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageReceiver$onReceive(android.content.Context, android.content.Intent)/context">context</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/content/Context.html"><span class="identifier">Context</span></a><span class="symbol">?</span><span class="symbol">, </span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageReceiver$onReceive(android.content.Context, android.content.Intent)/intent">intent</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/content/Intent.html"><span class="identifier">Intent</span></a><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksLanguageReceiver.onReceive - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.language</a>&nbsp;/&nbsp;<a href="index.html">DksLanguageReceiver</a>&nbsp;/&nbsp;<a href="./on-receive.html">onReceive</a><br/>
<br/>
<h1>onReceive</h1>
<a name="github.com.vikramezhil.dks.language.DksLanguageReceiver$onReceive(android.content.Context, android.content.Intent)"></a>
<code><span class="keyword">fun </span><span class="identifier">onReceive</span><span class="symbol">(</span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageReceiver$onReceive(android.content.Context, android.content.Intent)/context">context</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/content/Context.html"><span class="identifier">Context</span></a><span class="symbol">?</span><span class="symbol">, </span><span class="identifier" id="github.com.vikramezhil.dks.language.DksLanguageReceiver$onReceive(android.content.Context, android.content.Intent)/intent">intent</span><span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/content/Intent.html"><span class="identifier">Intent</span></a><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
</BODY>
</HTML>
32 changes: 32 additions & 0 deletions javadoc/dks/github.com.vikramezhil.dks.language/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>github.com.vikramezhil.dks.language - dks</title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">dks</a>&nbsp;/&nbsp;<a href="./index.html">github.com.vikramezhil.dks.language</a><br/>
<br/>
<h2>Package github.com.vikramezhil.dks.language</h2>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<h4><a href="-dks-language-listener/index.html">DksLanguageListener</a></h4>
</td>
<td>
<code><span class="keyword">interface </span><span class="identifier">DksLanguageListener</span></code></td>
</tr>
<tr>
<td>
<h4><a href="-dks-language-receiver/index.html">DksLanguageReceiver</a></h4>
</td>
<td>
<p>Droid Kotlin Speech Language Receiver</p>
<code><span class="keyword">class </span><span class="identifier">DksLanguageReceiver</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="https://developer.android.com/reference/android/content/BroadcastReceiver.html"><span class="identifier">BroadcastReceiver</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksEngine.<init> - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.speech</a>&nbsp;/&nbsp;<a href="index.html">DksEngine</a>&nbsp;/&nbsp;<a href="./-init-.html">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<a name="github.com.vikramezhil.dks.speech.DksEngine$&lt;init&gt;()"></a>
<code><span class="identifier">DksEngine</span><span class="symbol">(</span><span class="symbol">)</span></code>
<p>Droid Kotlin Speech Engine abstract</p>
<p><strong>Author</strong><br/>
vikramezhil</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksEngine.audioBeepDisabledTimeout - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.speech</a>&nbsp;/&nbsp;<a href="index.html">DksEngine</a>&nbsp;/&nbsp;<a href="./audio-beep-disabled-timeout.html">audioBeepDisabledTimeout</a><br/>
<br/>
<h1>audioBeepDisabledTimeout</h1>
<a name="github.com.vikramezhil.dks.speech.DksEngine$audioBeepDisabledTimeout"></a>
<code><span class="keyword">protected</span> <span class="keyword">val </span><span class="identifier">audioBeepDisabledTimeout</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html"><span class="identifier">Long</span></a></code>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksEngine.audioManager - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.speech</a>&nbsp;/&nbsp;<a href="index.html">DksEngine</a>&nbsp;/&nbsp;<a href="./audio-manager.html">audioManager</a><br/>
<br/>
<h1>audioManager</h1>
<a name="github.com.vikramezhil.dks.speech.DksEngine$audioManager"></a>
<code><span class="keyword">protected</span> <span class="keyword">abstract</span> <span class="keyword">var </span><span class="identifier">audioManager</span><span class="symbol">: </span><a href="https://developer.android.com/reference/android/media/AudioManager.html"><span class="identifier">AudioManager</span></a></code>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksEngine.cancelSpeechOperations - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.speech</a>&nbsp;/&nbsp;<a href="index.html">DksEngine</a>&nbsp;/&nbsp;<a href="./cancel-speech-operations.html">cancelSpeechOperations</a><br/>
<br/>
<h1>cancelSpeechOperations</h1>
<a name="github.com.vikramezhil.dks.speech.DksEngine$cancelSpeechOperations()"></a>
<code><span class="keyword">protected</span> <span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">cancelSpeechOperations</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Cancels the speech operations</p>
</BODY>
</HTML>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<HTML>
<HEAD>
<meta charset="UTF-8">
<title>DksEngine.closeSpeechOperations - dks</title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">dks</a>&nbsp;/&nbsp;<a href="../index.html">github.com.vikramezhil.dks.speech</a>&nbsp;/&nbsp;<a href="index.html">DksEngine</a>&nbsp;/&nbsp;<a href="./close-speech-operations.html">closeSpeechOperations</a><br/>
<br/>
<h1>closeSpeechOperations</h1>
<a name="github.com.vikramezhil.dks.speech.DksEngine$closeSpeechOperations()"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">closeSpeechOperations</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code>
<p>Closes the speech operations</p>
</BODY>
</HTML>
Loading

0 comments on commit 1b3245e

Please sign in to comment.