Merge pull request #3 from N7ghtm4r3/e1.0.3

Enhancement 1.0.3
N7ghtm4r3 · Sep 2, 2024 · dd8154c · dd8154c
2 parents f9994a0 + ecb319b
commit dd8154c
Show file tree

Hide file tree

Showing 379 changed files with 65,307 additions and 104 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Equinox
 
-**v1.0.2**
+**v1.0.3**
 
 Utilities for backend services based on Springboot framework. Is a support library to implement some utilities both for backend and for client also who comunicate with that Springboot backend
 
@@ -38,15 +38,15 @@ Add the JitPack repository to your build file
 
     ```gradle
     dependencies {
-        implementation 'com.github.N7ghtm4r3:Equinox:1.0.2'
+        implementation 'com.github.N7ghtm4r3:Equinox:1.0.3'
     }
     ```
 
   #### Gradle (Kotlin)
 
     ```gradle
     dependencies {
-        implementation("com.github.N7ghtm4r3:Equinox:1.0.2")
+        implementation("com.github.N7ghtm4r3:Equinox:1.0.3")
     }
     ```
 
@@ -68,7 +68,7 @@ Add the JitPack repository to your build file
 <dependency>
     <groupId>com.github.N7ghtm4r3</groupId>
   <artifactId>Equinox</artifactId>
-  <version>1.0.2</version>
+  <version>1.0.3</version>
 </dependency>
 ```
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,11 +1,23 @@
+import org.jetbrains.dokka.DokkaConfiguration.Visibility.*
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.DokkaBaseConfiguration
+import org.jetbrains.dokka.gradle.DokkaTask
+
 plugins {
     id("java")
     id("maven-publish")
     kotlin("jvm")
+    id("org.jetbrains.dokka") version "1.9.20"
+}
+
+buildscript {
+    dependencies {
+        classpath("org.jetbrains.dokka:dokka-base:1.9.20")
+    }
 }
 
 group = "com.tecknobit"
-version = "1.0.2"
+version = "1.0.3"
 
 repositories {
     mavenCentral()
@@ -32,7 +44,7 @@ afterEvaluate {
             create<MavenPublication>("maven") {
                 groupId = "com.tecknobit.equinox"
                 artifactId = "Equinox"
-                version = "1.0.2"
+                version = "1.0.3"
                 from(components["java"])
             }
         }
@@ -41,4 +53,17 @@ afterEvaluate {
 
 kotlin {
     jvmToolchain(18)
+}
+
+tasks.withType<DokkaTask>().configureEach {
+    outputDirectory.set(layout.projectDirectory.dir("docs"))
+    dokkaSourceSets.configureEach {
+        sourceRoots.from(file("src/main/kotlin"))
+        sourceRoots.from(file("src/main/java"))
+        includeNonPublic.set(true)
+        documentedVisibilities.set(setOf(PUBLIC, PROTECTED, PRIVATE))
+    }
+    pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
+        footerMessage = "(c) 2024 Tecknobit"
+    }
 }
diff --git a/docs/-equinox/com.tecknobit.equinox.annotations/-custom-parameters-order/index.html b/docs/-equinox/com.tecknobit.equinox.annotations/-custom-parameters-order/index.html
diff --git a/docs/-equinox/com.tecknobit.equinox.annotations/-custom-parameters-order/order.html b/docs/-equinox/com.tecknobit.equinox.annotations/-custom-parameters-order/order.html
@@ -0,0 +1,107 @@
+<!DOCTYPE html>
+<html class="no-js">
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>order</title>
+    <link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
+    <script>var pathToRoot = "../../../";</script>
+    <script>document.documentElement.classList.replace("no-js","js");</script>
+    <script>const storage = localStorage.getItem("dokka-dark-mode")
+    if (storage == null) {
+        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
+        if (osDarkSchemePreferred === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    } else {
+        const savedDarkMode = JSON.parse(storage)
+        if(savedDarkMode === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    }
+    </script>
+    <script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js"
+            async="async"></script>
+    <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
+    <link href="../../../styles/style.css" rel="Stylesheet">
+    <link href="../../../styles/main.css" rel="Stylesheet">
+    <link href="../../../styles/prism.css" rel="Stylesheet">
+    <link href="../../../styles/logo-styles.css" rel="Stylesheet">
+    <link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
+    <script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
+    <script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
+    <script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
+    <script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
+    <script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
+    <script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
+</head>
+<body>
+<div class="root">
+    <nav class="navigation" id="navigation-wrapper">
+        <div class="navigation--inner">
+            <div class="navigation-title">
+                <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
+                <div class="library-name">
+                    <a class="library-name--link" href="../../../index.html">
+                        Equinox
+                    </a>
+                </div>
+                <div class="library-version">
+                    1.0.3
+                </div>
+            </div>
+            <div class="filter-section" id="filter-section">
+                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">
+                    jvm
+                </button>
+            </div>
+        </div>
+        <div class="navigation-controls">
+            <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">
+                switch theme
+            </button>
+            <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in
+                API
+            </div>
+        </div>
+    </nav>
+    <div id="container">
+        <div class="sidebar" id="leftColumn">
+            <div class="sidebar--inner" id="sideMenu"></div>
+        </div>
+        <div id="main">
+            <div class="main-content" data-page-type="member" id="content"
+                 pageIds="Equinox::com.tecknobit.equinox.annotations/CustomParametersOrder/order/#/PointingToDeclaration//769193423">
+                <div class="breadcrumbs"><a href="../../../index.html">Equinox</a><span class="delimiter">/</span><a
+                        href="../index.html">com.tecknobit.equinox.annotations</a><span class="delimiter">/</span><a
+                        href="index.html">CustomParametersOrder</a><span class="delimiter">/</span><span
+                        class="current">order</span></div>
+                <div class="cover ">
+                    <h1 class="cover"><span><span>order</span></span></h1>
+                </div>
+                <div class="platform-hinted " data-platform-hinted="data-platform-hinted">
+                    <div class="content sourceset-dependent-content" data-active="" data-togglable=":dokkaHtml/main">
+                        <div class="symbol monospace"><span class="token keyword">abstract </span><span
+                                class="token keyword">fun </span><a href="order.html"><span
+                                class="token function">order</span></a><span class="token punctuation">(</span><span
+                                class="token punctuation">)</span><span class="token operator">: </span><a
+                                href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span
+                                class="token operator">&lt;</span><a
+                                href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html">String</a><span
+                                class="token operator">&gt;</span></div>
+                        <p class="paragraph">The order of the custom parameters of the custom <a
+                                href="../../com.tecknobit.equinox.environment.records/-equinox-user/index.html">EquinoxUser</a>
+                        </p></div>
+                </div>
+            </div>
+            <div class="footer">
+                <span class="go-to-top-icon"><a href="#content"
+                                                id="go-to-top-link"></a></span><span>(c) 2024 Tecknobit</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>
+            </div>
+        </div>
+    </div>
+</div>
+</body>
+</html>
diff --git a/docs/-equinox/com.tecknobit.equinox.annotations/index.html b/docs/-equinox/com.tecknobit.equinox.annotations/index.html
@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html class="no-js">
+<head>
+    <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
+    <title>com.tecknobit.equinox.annotations</title>
+    <link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
+    <script>var pathToRoot = "../../";</script>
+    <script>document.documentElement.classList.replace("no-js","js");</script>
+    <script>const storage = localStorage.getItem("dokka-dark-mode")
+    if (storage == null) {
+        const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
+        if (osDarkSchemePreferred === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    } else {
+        const savedDarkMode = JSON.parse(storage)
+        if(savedDarkMode === true) {
+            document.getElementsByTagName("html")[0].classList.add("theme-dark")
+        }
+    }
+    </script>
+    <script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js"
+            async="async"></script>
+    <script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
+    <link href="../../styles/style.css" rel="Stylesheet">
+    <link href="../../styles/main.css" rel="Stylesheet">
+    <link href="../../styles/prism.css" rel="Stylesheet">
+    <link href="../../styles/logo-styles.css" rel="Stylesheet">
+    <link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
+    <script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
+    <script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
+    <script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
+    <script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
+    <script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
+    <script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
+</head>
+<body>
+<div class="root">
+    <nav class="navigation" id="navigation-wrapper">
+        <div class="navigation--inner">
+            <div class="navigation-title">
+                <button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
+                <div class="library-name">
+                    <a class="library-name--link" href="../../index.html">
+                        Equinox
+                    </a>
+                </div>
+                <div class="library-version">
+                    1.0.3
+                </div>
+            </div>
+            <div class="filter-section" id="filter-section">
+                <button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">
+                    jvm
+                </button>
+            </div>
+        </div>
+        <div class="navigation-controls">
+            <button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">
+                switch theme
+            </button>
+            <div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in
+                API
+            </div>
+        </div>
+    </nav>
+    <div id="container">
+        <div class="sidebar" id="leftColumn">
+            <div class="sidebar--inner" id="sideMenu"></div>
+        </div>
+        <div id="main">
+            <div class="main-content" data-page-type="package" id="content"
+                 pageIds="Equinox::com.tecknobit.equinox.annotations////PointingToDeclaration//769193423">
+                <div class="breadcrumbs"><a href="../../index.html">Equinox</a><span class="delimiter">/</span><span
+                        class="current">com.tecknobit.equinox.annotations</span></div>
+                <div class="cover ">
+                    <h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span>
+                    </h1>
+                </div>
+                <div class="tabbedcontent">
+                    <div class="tabs-section" tabs-section="tabs-section">
+                        <button class="section-tab" data-active="" data-togglable="TYPE">Types</button>
+                    </div>
+                    <div class="tabs-section-body">
+                        <div data-togglable="TYPE">
+                            <h2 class="">Types</h2>
+                            <div class="table"><a data-name="-343618488%2FClasslikes%2F769193423"
+                                                  anchor-label="CustomParametersOrder"
+                                                  id="-343618488%2FClasslikes%2F769193423"
+                                                  data-filterable-set=":dokkaHtml/main"></a>
+                                <div class="table-row" data-filterable-current=":dokkaHtml/main"
+                                     data-filterable-set=":dokkaHtml/main">
+                                    <div class="main-subrow keyValue ">
+                                        <div class=""><span class="inline-flex">
+                  <div><a href="-custom-parameters-order/index.html"><span>Custom</span><wbr></wbr><span>Parameters</span><wbr></wbr><span><span>Order</span></span></a></div>
+<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-343618488%2FClasslikes%2F769193423"></span>
+                    <div class="copy-popup-wrapper "><span
+                            class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
+                  </span></span></div>
+                                        <div>
+                                            <div class="title">
+                                                <div class="platform-hinted "
+                                                     data-platform-hinted="data-platform-hinted">
+                                                    <div class="content sourceset-dependent-content" data-active=""
+                                                         data-togglable=":dokkaHtml/main">
+                                                        <div class="symbol monospace">
+                                                            <div class="block">
+                                                                <div class="block"><span
+                                                                        class="token annotation builtin">@</span><a
+                                                                        href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html"><span
+                                                                        class="token annotation builtin">Target</span></a><span
+                                                                        class="token punctuation">(</span><span>value<span
+                                                                        class="token operator"> = </span><a
+                                                                        href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html#METHOD">METHOD</a></span>
+                                                                    <wbr></wbr>
+                                                                    <span class="token punctuation">)</span></div>
+                                                                <div class="block"><span
+                                                                        class="token annotation builtin">@</span><a
+                                                                        href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html"><span
+                                                                        class="token annotation builtin">Retention</span></a><span
+                                                                        class="token punctuation">(</span><span>value<span
+                                                                        class="token operator"> = </span><a
+                                                                        href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html#SOURCE">SOURCE</a></span>
+                                                                    <wbr></wbr>
+                                                                    <span class="token punctuation">)</span></div>
+                                                            </div>
+                                                            <span class="token keyword">annotation class </span><a
+                                                                href="-custom-parameters-order/index.html">CustomParametersOrder</a>
+                                                        </div>
+                                                        <div class="brief ">The <code class="lang-kotlin">CustomParametersOrder</code>
+                                                            annotation is useful to manage the custom parameters order
+                                                            for a better readability of the code and to work with that
+                                                            parameters correctly
+                                                        </div>
+                                                    </div>
+                                                </div>
+                                            </div>
+                                        </div>
+                                    </div>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
+            <div class="footer">
+                <span class="go-to-top-icon"><a href="#content"
+                                                id="go-to-top-link"></a></span><span>(c) 2024 Tecknobit</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>
+            </div>
+        </div>
+    </div>
+</div>
+</body>
+</html>