Skip to content

Commit 8da1465

Browse files
cybercoder-najcybercoder-naj
committed
feat: module level documentation
1 parent 625bb7a commit 8da1465

File tree

25 files changed

+50
-33
lines changed

25 files changed

+50
-33
lines changed

‎build.gradle.kts‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@ plugins {
1111
group = "io.github.cybercoder-naj"
1212
version = libs.versions.lib.get()
1313

14-
extra["docsDir"] = layout.projectDirectory.dir("docs/")
15-
val docsDir = extra["docsDir"] as Directory
14+
val docsDir = layout.projectDirectory.dir("docs/")
15+
val dokkaPluginConfig = """
16+
{
17+
"footerMessage": "© 2024 Nishant Aanjaney Jalan"
18+
}
19+
"""
1620

1721
buildscript {
1822
dependencies {
@@ -27,8 +31,6 @@ allprojects {
2731
}
2832

2933
subprojects {
30-
extra["docsDir"] = rootProject.extra["docsDir"]
31-
3234
apply(plugin = "org.jetbrains.dokka")
3335
tasks.withType<DokkaTaskPartial>().configureEach {
3436
dokkaSourceSets.configureEach {
@@ -38,6 +40,12 @@ subprojects {
3840
remoteLineSuffix.set("#L")
3941
}
4042
}
43+
44+
pluginsMapConfiguration.set(
45+
mapOf(
46+
"org.jetbrains.dokka.base.DokkaBase" to dokkaPluginConfig
47+
)
48+
)
4149
}
4250
}
4351

@@ -48,14 +56,9 @@ tasks.dokkaHtmlMultiModule {
4856
}
4957

5058
tasks.withType<DokkaMultiModuleTask>().configureEach {
51-
val config = """
52-
{
53-
"footerMessage": "© 2024 Nishant Aanjaney Jalan"
54-
}
55-
"""
5659
pluginsMapConfiguration.set(
5760
mapOf(
58-
"org.jetbrains.dokka.base.DokkaBase" to config
61+
"org.jetbrains.dokka.base.DokkaBase" to dokkaPluginConfig
5962
)
6063
)
6164
}

‎core/build.gradle.kts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ kotlin {
3333
tasks.withType<DokkaTaskPartial>().configureEach {
3434
dokkaSourceSets.configureEach {
3535
moduleName.set("parkour")
36+
includes.from(projectDir.resolve("docs.md"))
3637
}
3738
}
3839

‎core/docs.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Module parkour
2+
3+
A parser combinator library in Kotlin for JVM users.
4+
5+
# Package io.github.cybercodernaj.parkour.lexer
6+
7+
Docs for the lexer

‎docs/core/index.html‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
<div class="breadcrumbs"></div>
6363
<div class="cover ">
6464
<h1 class="cover"><span><span>parkour</span></span></h1>
65+
<div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/main"><p class="paragraph">A parser combinator library in Kotlin for JVM users.</p></div></div>
6566
</div>
6667
<h2 class="">Packages</h2>
6768
<div class="table"><a data-name="1881876024%2FPackages%2F537371977" anchor-label="io.github.cybercodernaj.parkour.exceptions" id="1881876024%2FPackages%2F537371977" data-filterable-set=":core:dokkaHtmlPartial/main"></a>
@@ -97,7 +98,9 @@ <h2 class="">Packages</h2>
9798
</div>
9899
</div>
99100
</div>
100-
<div></div>
101+
<div><span class="brief-comment"><a data-name="-545240740%2FPackages%2F537371977" anchor-label="io.github.cybercodernaj.parkour.lexer" id="-545240740%2FPackages%2F537371977" data-filterable-set=":core:dokkaHtmlPartial/main"></a>
102+
<p class="paragraph">Docs for the lexer</p>
103+
</span></div>
101104
</div>
102105
</div>
103106
<a data-name="1070000851%2FPackages%2F537371977" anchor-label="io.github.cybercodernaj.parkour.lexer.internal" id="1070000851%2FPackages%2F537371977" data-filterable-set=":core:dokkaHtmlPartial/main"></a>
@@ -121,7 +124,7 @@ <h2 class="">Packages</h2>
121124
</div>
122125
</div>
123126
<div class="footer">
124-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
127+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Nishant Aanjaney Jalan</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
125128
</div>
126129
</div>
127130
</div>

‎docs/core/io.github.cybercodernaj.parkour.exceptions/-lexical-exception/-lexical-exception.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>Lexical</span><wbr><span><span>Exception</span></span></
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">message<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter ">cause<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html">Throwable</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/core/src/main/kotlin/io/github/cybercodernaj/parkour/exceptions/LexicalException.kt#L12">source</a>)</span></span></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Nishant Aanjaney Jalan</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

‎docs/core/io.github.cybercodernaj.parkour.exceptions/-lexical-exception/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ <h2 class="">Functions</h2>
248248
</div>
249249
</div>
250250
<div class="footer">
251-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
251+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Nishant Aanjaney Jalan</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
252252
</div>
253253
</div>
254254
</div>

‎docs/core/io.github.cybercodernaj.parkour.exceptions/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h2 class="">Types</h2>
8989
</div>
9090
</div>
9191
<div class="footer">
92-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
92+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Nishant Aanjaney Jalan</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
9393
</div>
9494
</div>
9595
</div>

‎docs/core/io.github.cybercodernaj.parkour.lexer.internal/-lexer/-defaults/escape-sequences.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>escape</span><wbr><span><span>Sequences</span></span></h
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="escape-sequences.html">escapeSequences</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token punctuation">, </span><span class="token punctuation">(</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.html">Char</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/core/src/main/kotlin/io/github/cybercodernaj/parkour/lexer/internal/Lexer.kt#L81">source</a>)</span></span></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Nishant Aanjaney Jalan</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

‎docs/core/io.github.cybercodernaj.parkour.lexer.internal/-lexer/-defaults/floating-literals.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span>floating</span><wbr><span><span>Literals</span></span></
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="floating-literals.html">floatingLiterals</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/core/src/main/kotlin/io/github/cybercodernaj/parkour/lexer/internal/Lexer.kt#L79">source</a>)</span></span></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Nishant Aanjaney Jalan</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

‎docs/core/io.github.cybercodernaj.parkour.lexer.internal/-lexer/-defaults/identifiers.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ <h1 class="cover"><span><span>identifiers</span></span></h1>
6666
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">val </span><a href="identifiers.html">identifiers</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cybercoder-naj/parkour/tree/main/core/src/main/kotlin/io/github/cybercodernaj/parkour/lexer/internal/Lexer.kt#L77">source</a>)</span></span></div></div></div>
6767
</div>
6868
<div class="footer">
69-
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
69+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Nishant Aanjaney Jalan</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
7070
</div>
7171
</div>
7272
</div>

0 commit comments

Comments
 (0)