docs

Author: drtheodor

build.gradle.kts

@@ -1,4 +1,5 @@
 import org.gradle.internal.os.OperatingSystem
+import java.time.Year
 
 plugins {
     id("java")
@@ -102,4 +103,33 @@ dokka {
     }
 }
 
+tasks.javadoc {
+    options {
+        this as StandardJavadocDocletOptions
+
+        tags = listOf(
+            "apiNote:a:API Note:",
+            "implSpec:a:Implementation Requirements:",
+            "implNote:a:Implementation Note:"
+        )
+
+        encoding = "UTF-8"
+        docEncoding = "UTF-8"
+        charSet = "UTF-8"
+        memberLevel = JavadocMemberLevel.PROTECTED
+
+        windowTitle = "AutoJSON API"
+        docTitle = "AutoJSON API Documentation"
+        bottom = """
+            <a href="https://theo.is-a.dev/">DrTheo_</a> © ${Year.now().value}
+        """.trimIndent()
+
+        links("https://docs.oracle.com/en/java/javase/17/docs/api/")
+    }
+
+    if (JavaVersion.current().isJava9Compatible) {
+        (options as StandardJavadocDocletOptions).addBooleanOption("html5", true)
+    }
+}
+
 tasks["publishLibPublicationToGhRepository"].finalizedBy("pushMavenRepo")

docs/astro.config.mjs

@@ -9,19 +9,25 @@ export default defineConfig({
 	integrations: [
 		starlight({
 			title: 'AutoJSON',
-			social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }],
+			social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/DrTheodor/autojson' }],
 			sidebar: [
+				{
+					label: 'Reference',
+					badge: 'JavaDocs',
+					link: '/reference',
+				},
 				{
 					label: 'Guides',
 					items: [
 						// Each item here is one entry in the navigation menu.
-						{ label: 'Example Guide', slug: 'guides/example' },
+						{ label: 'Getting Started', slug: 'guides/getting-started' },
+						{ label: 'Annotations', slug: 'guides/annotations' },
+						{ label: 'Schemas', slug: 'guides/schemas' },
+						{ label: 'Layers', slug: 'guides/layers' },
+						{ label: 'Logger', slug: 'guides/logger' },
+						{ label: 'Tips & Tricks', slug: 'guides/tips-n-tricks' },
 					],
 				},
-				{
-					label: 'Reference',
-					autogenerate: { directory: 'reference' },
-				},
 			],
 			editLink: {
 				baseUrl: 'https://github.com/DrTheodor/autojson/edit/main/docs/'

docs/public/reference/autojson/dev.drtheo.autojson/-auto-j-s-o-n/-auto-j-s-o-n.html

@@ -112,7 +112,7 @@
   <div class="cover ">
     <h1 class="cover"><span>Auto</span><wbr></wbr><span><span>JSON</span></span></h1>
   </div>
-  <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="-auto-j-s-o-n.html"><span class="token function">AutoJSON</span></a><span class="token punctuation">(</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/AutoJSON.java#L37">source</a>)</span></span></div></div></div>
+  <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="-auto-j-s-o-n.html"><span class="token function">AutoJSON</span></a><span class="token punctuation">(</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/AutoJSON.java#L38">source</a>)</span></span></div></div></div>
 </div>
     <div class="footer">
         <a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>

docs/public/reference/autojson/dev.drtheo.autojson/-auto-j-s-o-n/-template-creator/index.html

@@ -111,7 +111,7 @@
   <div class="breadcrumbs"><a href="../../../../index.html">autojson</a><span class="delimiter">/</span><a href="../../index.html">dev.drtheo.autojson</a><span class="delimiter">/</span><a href="../index.html">AutoJSON</a><span class="delimiter">/</span><span class="current">TemplateCreator</span></div>
   <div class="cover ">
     <h1 class="cover"><span>Template</span><wbr></wbr><span><span>Creator</span></span></h1>
-    <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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/FunctionalInterface.html"><span class="token annotation builtin">FunctionalInterface</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div><span class="token keyword">public </span><span class="token keyword">interface </span><a href="index.html">TemplateCreator</a><span class="token operator">&lt;</span>T<span class="token operator">&gt;</span><span class="token keyword"> implements </span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html">BiFunction</a><span class="token operator">&lt;</span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html">T</a><span class="token punctuation">, </span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html">U</a><span class="token punctuation">, </span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html">R</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main/src/main/java/dev/drtheo/autojson/AutoJSON.java#L253">source</a>)</span></span></div></div></div>
+    <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"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/FunctionalInterface.html"><span class="token annotation builtin">FunctionalInterface</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div><span class="token keyword">public </span><span class="token keyword">interface </span><a href="index.html">TemplateCreator</a><span class="token operator">&lt;</span>T<span class="token operator">&gt;</span><span class="token keyword"> implements </span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html">BiFunction</a><span class="token operator">&lt;</span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html">T</a><span class="token punctuation">, </span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html">U</a><span class="token punctuation">, </span><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BiFunction.html">R</a><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/DrTheodor/autojson/blob/main/src/main/java/dev/drtheo/autojson/AutoJSON.java#L259">source</a>)</span></span></div></div></div>
   </div>
   <div class="tabbedcontent">
     <div class="tabs-section" tabs-section="tabs-section"></div>

docs/public/reference/autojson/dev.drtheo.autojson/-auto-j-s-o-n/add-layer.html

@@ -112,7 +112,7 @@
   <div class="cover ">
     <h1 class="cover"><span>add</span><wbr></wbr><span><span>Layer</span></span></h1>
   </div>
-  <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="add-layer.html"><span class="token function">addLayer</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span>int layer</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/AutoJSON.java#L89">source</a>)</span></span></div><h4 class="">Parameters</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><u><span><span>layer</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the layer(s) to add to this <a href="index.html">AutoJSON</a> instance.</p></div></div></div></div></div></div></div>
+  <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="add-layer.html"><span class="token function">addLayer</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span>int layer</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/AutoJSON.java#L94">source</a>)</span></span></div><h4 class="">Parameters</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><u><span><span>layer</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the layer(s) to add to this <a href="index.html">AutoJSON</a> instance.</p></div></div></div></div></div><h4 class="">See also</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="get-layer.html"><span>get</span><wbr></wbr><span><span>Layer()</span></span></a></div></span></div><div></div></div></div><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="set-layer.html"><span>set</span><wbr></wbr><span><span>Layer(int)</span></span></a></div></span></div><div></div></div></div></div></div></div>
 </div>
     <div class="footer">
         <a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>

docs/public/reference/autojson/dev.drtheo.autojson/-auto-j-s-o-n/from-json.html

@@ -112,7 +112,7 @@
   <div class="cover ">
     <h1 class="cover"><span>from</span><wbr></wbr><span><span>Json</span></span></h1>
   </div>
-  <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><a href="from-json.html">F</a> <a href="from-json.html"><span class="token function">fromJson</span></a><span class="token operator">&lt;</span>F<span class="token punctuation">, </span>T<span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="../../dev.drtheo.autojson.adapter/-json-adapter/index.html">JsonAdapter</a><span class="token operator">&lt;</span><a href="from-json.html">F</a><span class="token punctuation">, </span><a href="from-json.html">T</a><span class="token operator">&gt;</span> adapter<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword"></span><a href="from-json.html">T</a> obj<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/Class.html">Class</a><span class="token operator">&lt;</span><a href="from-json.html">F</a><span class="token operator">&gt;</span> clazz</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/AutoJSON.java#L243">source</a>)</span></span></div><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the deserialized object.</p></span><h4 class="">Parameters</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><u><span><span>adapter</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the adapter used to serialize the object.</p></div></div></div></div><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>obj</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the object to deserialize.</p></div></div></div></div><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>clazz</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type to deserialize via.</p></div></div></div></div><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>&lt;F&gt;</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type the adapter deserializes to.</p></div></div></div></div><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>&lt;T&gt;</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type the adapter deserializes from.</p></div></div></div></div></div></div></div>
+  <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><a href="from-json.html">F</a> <a href="from-json.html"><span class="token function">fromJson</span></a><span class="token operator">&lt;</span>F<span class="token punctuation">, </span>T<span class="token operator">&gt;</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword"></span><a href="../../dev.drtheo.autojson.adapter/-json-adapter/index.html">JsonAdapter</a><span class="token operator">&lt;</span><a href="from-json.html">F</a><span class="token punctuation">, </span><a href="from-json.html">T</a><span class="token operator">&gt;</span> adapter<span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword"></span><a href="from-json.html">T</a> obj<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/Class.html">Class</a><span class="token operator">&lt;</span><a href="from-json.html">F</a><span class="token operator">&gt;</span> clazz</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/AutoJSON.java#L249">source</a>)</span></span></div><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the deserialized object.</p></span><h4 class="">Parameters</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><u><span><span>adapter</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the adapter used to serialize the object.</p></div></div></div></div><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>obj</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the object to deserialize.</p></div></div></div></div><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>clazz</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type to deserialize via.</p></div></div></div></div><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>&lt;F&gt;</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type the adapter deserializes to.</p></div></div></div></div><div class="table-row" data-filterable-current=":/javaMain" data-filterable-set=":/javaMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>&lt;T&gt;</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type the adapter deserializes from.</p></div></div></div></div></div></div></div>
 </div>
     <div class="footer">
         <a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>

docs/public/reference/autojson/dev.drtheo.autojson/-auto-j-s-o-n/get-layer.html

@@ -112,7 +112,7 @@
   <div class="cover ">
     <h1 class="cover"><span>get</span><wbr></wbr><span><span>Layer</span></span></h1>
   </div>
-  <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>int <a href="get-layer.html"><span class="token function">getLayer</span></a><span class="token punctuation">(</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/AutoJSON.java#L96">source</a>)</span></span></div><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the current layers of this <a href="index.html">AutoJSON</a> instance.</p></span></div></div>
+  <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>int <a href="get-layer.html"><span class="token function">getLayer</span></a><span class="token punctuation">(</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/AutoJSON.java#L102">source</a>)</span></span></div><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the current layers of this <a href="index.html">AutoJSON</a> instance.</p></span></div></div>
 </div>
     <div class="footer">
         <a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>