Skip to content

Commit 5de61c9

Browse files
committed
dokka update, remove generated javadocs from the website
1 parent ad984ee commit 5de61c9

File tree

409 files changed

+572
-20377
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

409 files changed

+572
-20377
lines changed

assets/dokka/dokka.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@
22
--dokka-logo-image-url: url('../images/logo-icon-white.svg');
33
--dokka-logo-height: 100px;
44
--dokka-logo-width: 100px;
5+
}
6+
7+
.footer--link_personal {
8+
color: white;
59
}

build.gradle.kts

Lines changed: 14 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import org.gradle.internal.os.OperatingSystem
2-
import java.time.Year
32

43
plugins {
54
id("java")
@@ -57,14 +56,17 @@ task<Exec>("pushMavenRepo") {
5756
}
5857

5958
task("justPublish") {
60-
dependsOn(tasks.javadoc)
59+
dependsOn(tasks.dokkaGenerate)
6160
dependsOn(tasks["publishLibPublicationToGhRepository"])
6261
}
6362

6463
dokka {
6564
val docsFolder = layout.projectDirectory.dir("docs").dir("public")
66-
val assets = layout.projectDirectory.dir("assets")
67-
val dokkaAssets = assets.dir("dokka")
65+
val dokkaAssets = layout.projectDirectory.dir("assets").dir("dokka")
66+
67+
val name = "DrTheo_"
68+
val repo = "https://github.com/DrTheodor/autojson"
69+
val personalLink = "https://theo.is-a.dev/"
6870

6971
moduleName.set("autojson")
7072

@@ -79,56 +81,25 @@ dokka {
7981
jdkVersion.set(17)
8082

8183
externalDocumentationLinks.register("jdk17") {
82-
url("https://docs.oracle.com/en/java/javase/17/docs/api/")
83-
packageListUrl("https://docs.oracle.com/en/java/javase/17/docs/api/element-list")
84+
val jdkDocs = "https://docs.oracle.com/en/java/javase/17/docs/api"
85+
url("$jdkDocs/")
86+
packageListUrl("$jdkDocs/element-list")
8487
}
8588

8689
sourceLink {
87-
localDirectory.set(file("src/main/java"))
88-
remoteUrl("https://github.com/DrTheodor/autojson/blob/main/")
90+
val path = "src/main/java"
91+
localDirectory.set(file(path))
92+
remoteUrl("$repo/blob/main/$path")
8993
remoteLineSuffix.set("#L")
9094
}
9195
}
9296
pluginsConfiguration.html {
9397
customStyleSheets.from(dokkaAssets.file("dokka.css"))
9498
customAssets.from(dokkaAssets.file("logo-icon-white.svg"), dokkaAssets.file("logo-icon.svg"))
95-
footerMessage.set("(c) DrTheo_")
96-
}
97-
}
98-
99-
tasks.javadoc {
100-
val docsFolder = layout.projectDirectory.dir("docs").dir("public")
101-
102-
options {
103-
this as StandardJavadocDocletOptions
104-
105-
tags = listOf(
106-
"apiNote:a:API Note:",
107-
"implSpec:a:Implementation Requirements:",
108-
"implNote:a:Implementation Note:"
109-
)
11099

111-
encoding = "UTF-8"
112-
docEncoding = "UTF-8"
113-
charSet = "UTF-8"
114-
memberLevel = JavadocMemberLevel.PROTECTED
115-
116-
windowTitle = "AutoJSON API"
117-
docTitle = "AutoJSON API Documentation"
118-
bottom = """
119-
<a href="https://theo.is-a.dev/">DrTheo_</a> © ${Year.now().value}
120-
""".trimIndent()
121-
122-
links("https://docs.oracle.com/en/java/javase/17/docs/api/")
123-
124-
addStringOption("stylesheetfile", docsFolder.file("javadocs.css").asFile.absolutePath)
100+
val footerClass = "footer--link_personal"
101+
footerMessage.set("(c) <a class=\"$footerClass\" href=\"$personalLink\">$name</a>")
125102
}
126-
127-
if (JavaVersion.current().isJava9Compatible) {
128-
(options as StandardJavadocDocletOptions).addBooleanOption("html5", true)
129-
}
130-
131-
setDestinationDir(docsFolder.dir("javadocs").asFile)
132103
}
133104

134105
tasks["publishLibPublicationToGhRepository"].finalizedBy("pushMavenRepo")

docs/public/dokka/autojson/dev.drtheo.autojson.adapter.string.parser/-json-parse-exception/-json-parse-exception.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,11 @@
112112
<div class="cover ">
113113
<h1 class="cover"><span>Json</span><wbr></wbr><span>Parse</span><wbr></wbr><span><span>Exception</span></span></h1>
114114
</div>
115-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/javaMain"><div class="symbol monospace block"><span class="token keyword">public </span><span class="token keyword"></span>void <a href="-json-parse-exception.html"><span class="token function">JsonParseException</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html">String</a> msg</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main//dev/drtheo/autojson/adapter/string/parser/JsonParseException.java#L9">source</a>)</span></span></div><div class="symbol monospace block"><span class="token keyword">public </span><span class="token keyword"></span>void <a href="-json-parse-exception.html"><span class="token function">JsonParseException</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html">String</a> msg<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html">Throwable</a> cause</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main//dev/drtheo/autojson/adapter/string/parser/JsonParseException.java#L13">source</a>)</span></span></div><div class="symbol monospace block"><span class="token keyword">public </span><span class="token keyword"></span>void <a href="-json-parse-exception.html"><span class="token function">JsonParseException</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html">Throwable</a> cause</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main//dev/drtheo/autojson/adapter/string/parser/JsonParseException.java#L17">source</a>)</span></span></div></div></div>
115+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/javaMain"><div class="symbol monospace block"><span class="token keyword">public </span><span class="token keyword"></span>void <a href="-json-parse-exception.html"><span class="token function">JsonParseException</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html">String</a> msg</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main/src/main/java/dev/drtheo/autojson/adapter/string/parser/JsonParseException.java#L9">source</a>)</span></span></div><div class="symbol monospace block"><span class="token keyword">public </span><span class="token keyword"></span>void <a href="-json-parse-exception.html"><span class="token function">JsonParseException</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html">String</a> msg<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html">Throwable</a> cause</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main/src/main/java/dev/drtheo/autojson/adapter/string/parser/JsonParseException.java#L13">source</a>)</span></span></div><div class="symbol monospace block"><span class="token keyword">public </span><span class="token keyword"></span>void <a href="-json-parse-exception.html"><span class="token function">JsonParseException</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html">Throwable</a> cause</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main/src/main/java/dev/drtheo/autojson/adapter/string/parser/JsonParseException.java#L17">source</a>)</span></span></div></div></div>
116116
</div>
117117
<div class="footer">
118118
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
119-
<span>(c) DrTheo_</span>
119+
<span>(c) <a class="footer--link_personal" href="https://theo.is-a.dev/">DrTheo_</a></span>
120120
<span class="pull-right">
121121
<span>Generated by </span>
122122
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">

docs/public/dokka/autojson/dev.drtheo.autojson.adapter.string.parser/-json-parse-exception/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@
111111
<div class="breadcrumbs"><a href="../../../index.html">autojson</a><span class="delimiter">/</span><a href="../index.html">dev.drtheo.autojson.adapter.string.parser</a><span class="delimiter">/</span><span class="current">JsonParseException</span></div>
112112
<div class="cover ">
113113
<h1 class="cover"><span>Json</span><wbr></wbr><span>Parse</span><wbr></wbr><span><span>Exception</span></span></h1>
114-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/javaMain"><div class="symbol monospace"><span class="token keyword">public </span><span class="token keyword">class </span><a href="index.html">JsonParseException</a><span class="token keyword"> extends </span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html">RuntimeException</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main//dev/drtheo/autojson/adapter/string/parser/JsonParseException.java#L5">source</a>)</span></span></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-json-syntax-exception/index.html">JsonSyntaxException</a></div></span></div><div></div></div></div></div></div></div>
114+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/javaMain"><div class="symbol monospace"><span class="token keyword">public </span><span class="token keyword">class </span><a href="index.html">JsonParseException</a><span class="token keyword"> extends </span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/RuntimeException.html">RuntimeException</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main/src/main/java/dev/drtheo/autojson/adapter/string/parser/JsonParseException.java#L5">source</a>)</span></span></div><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-json-syntax-exception/index.html">JsonSyntaxException</a></div></span></div><div></div></div></div></div></div></div>
115115
</div>
116116
<div class="tabbedcontent">
117117
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
@@ -140,7 +140,7 @@ <h2 class="">Constructors</h2>
140140
</div>
141141
<div class="footer">
142142
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
143-
<span>(c) DrTheo_</span>
143+
<span>(c) <a class="footer--link_personal" href="https://theo.is-a.dev/">DrTheo_</a></span>
144144
<span class="pull-right">
145145
<span>Generated by </span>
146146
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">

docs/public/dokka/autojson/dev.drtheo.autojson.adapter.string.parser/-json-reader/-json-reader.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,11 @@
112112
<div class="cover ">
113113
<h1 class="cover"><span>Json</span><wbr></wbr><span><span>Reader</span></span></h1>
114114
</div>
115-
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/javaMain"><div class="symbol monospace block"><span class="token keyword">public </span><span class="token keyword"></span>void <a href="-json-reader.html"><span class="token function">JsonReader</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html">String</a> raw</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main//dev/drtheo/autojson/adapter/string/parser/JsonReader.java#L27">source</a>)</span></span></div></div></div>
115+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":/javaMain"><div class="symbol monospace block"><span class="token keyword">public </span><span class="token keyword"></span>void <a href="-json-reader.html"><span class="token function">JsonReader</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html">String</a> raw</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main/src/main/java/dev/drtheo/autojson/adapter/string/parser/JsonReader.java#L27">source</a>)</span></span></div></div></div>
116116
</div>
117117
<div class="footer">
118118
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
119-
<span>(c) DrTheo_</span>
119+
<span>(c) <a class="footer--link_personal" href="https://theo.is-a.dev/">DrTheo_</a></span>
120120
<span class="pull-right">
121121
<span>Generated by </span>
122122
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">

docs/public/dokka/autojson/dev.drtheo.autojson.adapter.string.parser/-json-reader/-token-type/-b-e-g-i-n_-a-r-r-a-y/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ <h1 class="cover"><span>BEGIN_</span><wbr></wbr><span>ARRAY</span></h1>
120120
</div>
121121
<div class="footer">
122122
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
123-
<span>(c) DrTheo_</span>
123+
<span>(c) <a class="footer--link_personal" href="https://theo.is-a.dev/">DrTheo_</a></span>
124124
<span class="pull-right">
125125
<span>Generated by </span>
126126
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">

docs/public/dokka/autojson/dev.drtheo.autojson.adapter.string.parser/-json-reader/-token-type/-b-e-g-i-n_-o-b-j-e-c-t/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ <h1 class="cover"><span>BEGIN_</span><wbr></wbr><span>OBJECT</span></h1>
120120
</div>
121121
<div class="footer">
122122
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
123-
<span>(c) DrTheo_</span>
123+
<span>(c) <a class="footer--link_personal" href="https://theo.is-a.dev/">DrTheo_</a></span>
124124
<span class="pull-right">
125125
<span>Generated by </span>
126126
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">

docs/public/dokka/autojson/dev.drtheo.autojson.adapter.string.parser/-json-reader/-token-type/-b-o-o-l/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ <h1 class="cover"><span><span>BOOL</span></span></h1>
120120
</div>
121121
<div class="footer">
122122
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
123-
<span>(c) DrTheo_</span>
123+
<span>(c) <a class="footer--link_personal" href="https://theo.is-a.dev/">DrTheo_</a></span>
124124
<span class="pull-right">
125125
<span>Generated by </span>
126126
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">

docs/public/dokka/autojson/dev.drtheo.autojson.adapter.string.parser/-json-reader/-token-type/-e-n-d_-a-r-r-a-y/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ <h1 class="cover"><span>END_</span><wbr></wbr><span>ARRAY</span></h1>
120120
</div>
121121
<div class="footer">
122122
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
123-
<span>(c) DrTheo_</span>
123+
<span>(c) <a class="footer--link_personal" href="https://theo.is-a.dev/">DrTheo_</a></span>
124124
<span class="pull-right">
125125
<span>Generated by </span>
126126
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">

docs/public/dokka/autojson/dev.drtheo.autojson.adapter.string.parser/-json-reader/-token-type/-e-n-d_-o-b-j-e-c-t/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ <h1 class="cover"><span>END_</span><wbr></wbr><span>OBJECT</span></h1>
120120
</div>
121121
<div class="footer">
122122
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
123-
<span>(c) DrTheo_</span>
123+
<span>(c) <a class="footer--link_personal" href="https://theo.is-a.dev/">DrTheo_</a></span>
124124
<span class="pull-right">
125125
<span>Generated by </span>
126126
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">

0 commit comments

Comments
 (0)