Skip to content

Commit 90f3b7e

Browse files
committed
Update Dokka (94272c8)
1 parent 0306820 commit 90f3b7e

File tree

7 files changed

+218
-20
lines changed

7 files changed

+218
-20
lines changed
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>checkUserConfig</title>
6+
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../styles/style.css" rel="Stylesheet">
25+
<link href="../../styles/main.css" rel="Stylesheet">
26+
<link href="../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../index.html">
44+
codemc-api
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
1.0.2 </div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="member" id="content" pageIds="codemc-api::io.codemc.api.jenkins//checkUserConfig/#kotlin.String/PointingToDeclaration//769193423">
65+
<div class="breadcrumbs"><a href="../../index.html">codemc-api</a><span class="delimiter">/</span><a href="index.html">io.codemc.api.jenkins</a><span class="delimiter">/</span><span class="current">checkUserConfig</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span>check</span><wbr></wbr><span>User</span><wbr></wbr><span><span>Config</span></span></h1>
68+
</div>
69+
<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">fun </span><a href="check-user-config.html"><span class="token function">checkUserConfig</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">username<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><p class="paragraph">Checks the user <code class="lang-kotlin">config.xml</code> present on the Jenkins CI.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph"><code class="lang-kotlin">true</code> if the user configuration was changed, <code class="lang-kotlin">false</code> otherwise.</p></span><h4 class="">Parameters</h4><div class="table"><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><u><span><span>username</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The username of the user.</p></div></div></div></div></div></div></div>
70+
</div>
71+
<div class="footer">
72+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
73+
class="pull-right"><span>Generated by </span><a
74+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
75+
</div>
76+
</div>
77+
</div>
78+
</div>
79+
</body>
80+
</html>

codemc-api/io.codemc.api.jenkins/index.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,21 @@ <h2 class="">Functions</h2>
199199
</div>
200200
</div>
201201
</div>
202+
<a data-name="1686915197%2FFunctions%2F769193423" anchor-label="checkUserConfig" id="1686915197%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
203+
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
204+
<div class="main-subrow keyValue ">
205+
<div class=""><span class="inline-flex">
206+
<div><a href="check-user-config.html"><span>check</span><wbr></wbr><span>User</span><wbr></wbr><span><span>Config</span></span></a></div>
207+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1686915197%2FFunctions%2F769193423"></span>
208+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
209+
</span></span></div>
210+
<div>
211+
<div class="title">
212+
<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">fun </span><a href="check-user-config.html"><span class="token function">checkUserConfig</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">username<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Checks the user <code class="lang-kotlin">config.xml</code> present on the Jenkins CI.</p></div></div></div>
213+
</div>
214+
</div>
215+
</div>
216+
</div>
202217
<a data-name="794218520%2FFunctions%2F769193423" anchor-label="createJenkinsJob" id="794218520%2FFunctions%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
203218
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
204219
<div class="main-subrow keyValue ">
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!DOCTYPE html>
2+
<html class="no-js">
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>MAVEN_SETTINGS_XML</title>
6+
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../";</script>
8+
<script>document.documentElement.classList.replace("no-js","js");</script>
9+
<script>const storage = localStorage.getItem("dokka-dark-mode")
10+
if (storage == null) {
11+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
12+
if (osDarkSchemePreferred === true) {
13+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
14+
}
15+
} else {
16+
const savedDarkMode = JSON.parse(storage)
17+
if(savedDarkMode === true) {
18+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
19+
}
20+
}
21+
</script>
22+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
23+
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
24+
<link href="../../styles/style.css" rel="Stylesheet">
25+
<link href="../../styles/main.css" rel="Stylesheet">
26+
<link href="../../styles/prism.css" rel="Stylesheet">
27+
<link href="../../styles/logo-styles.css" rel="Stylesheet">
28+
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
29+
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
30+
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
31+
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
32+
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
33+
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
34+
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
35+
</head>
36+
<body>
37+
<div class="root">
38+
<nav class="navigation" id="navigation-wrapper">
39+
<div class="navigation--inner">
40+
<div class="navigation-title">
41+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
42+
<div class="library-name">
43+
<a class="library-name--link" href="../../index.html">
44+
codemc-api
45+
</a>
46+
</div>
47+
<div class="library-version">
48+
1.0.2 </div>
49+
</div>
50+
<div class="filter-section" id="filter-section">
51+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":dokkaHtml/main">jvm</button>
52+
</div>
53+
</div>
54+
<div class="navigation-controls">
55+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
56+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
57+
</div>
58+
</nav>
59+
<div id="container">
60+
<div class="sidebar" id="leftColumn">
61+
<div class="sidebar--inner" id="sideMenu"></div>
62+
</div>
63+
<div id="main">
64+
<div class="main-content" data-page-type="member" id="content" pageIds="codemc-api::io.codemc.api//MAVEN_SETTINGS_XML/#/PointingToDeclaration//769193423">
65+
<div class="breadcrumbs"><a href="../../index.html">codemc-api</a><span class="delimiter">/</span><a href="index.html">io.codemc.api</a><span class="delimiter">/</span><span class="current">MAVEN_SETTINGS_XML</span></div>
66+
<div class="cover ">
67+
<h1 class="cover"><span><span>MAVEN_SETTINGS_XML</span></span></h1>
68+
</div>
69+
<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">const </span><span class="token keyword">val </span><a href="-m-a-v-e-n_-s-e-t-t-i-n-g-s_-x-m-l.html">MAVEN_SETTINGS_XML</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">The ID of the maven settings template for jenkins credentials.</p></div></div>
70+
</div>
71+
<div class="footer">
72+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span
73+
class="pull-right"><span>Generated by </span><a
74+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
75+
</div>
76+
</div>
77+
</div>
78+
</div>
79+
</body>
80+
</html>

codemc-api/io.codemc.api/index.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,21 @@ <h2 class="">Properties</h2>
131131
</div>
132132
</div>
133133
</div>
134+
<a data-name="-1525757385%2FProperties%2F769193423" anchor-label="MAVEN_SETTINGS_XML" id="-1525757385%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
135+
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
136+
<div class="main-subrow keyValue ">
137+
<div class=""><span class="inline-flex">
138+
<div><a href="-m-a-v-e-n_-s-e-t-t-i-n-g-s_-x-m-l.html"><span><span>MAVEN_SETTINGS_XML</span></span></a></div>
139+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1525757385%2FProperties%2F769193423"></span>
140+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
141+
</span></span></div>
142+
<div>
143+
<div class="title">
144+
<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">const </span><span class="token keyword">val </span><a href="-m-a-v-e-n_-s-e-t-t-i-n-g-s_-x-m-l.html">MAVEN_SETTINGS_XML</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><div class="brief "><p class="paragraph">The ID of the maven settings template for jenkins credentials.</p></div></div></div>
145+
</div>
146+
</div>
147+
</div>
148+
</div>
134149
<a data-name="-346639051%2FProperties%2F769193423" anchor-label="RESOURCE_CACHE" id="-346639051%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
135150
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
136151
<div class="main-subrow keyValue ">

codemc-api/package-list

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ $dokka.location:io.codemc.api.jenkins//NEXUS_CREDENTIALS_DESCRIPTION/#/PointingT
2828
$dokka.location:io.codemc.api.jenkins//NEXUS_CREDENTIALS_ID/#/PointingToDeclaration/codemc-api/io.codemc.api.jenkins/-n-e-x-u-s_-c-r-e-d-e-n-t-i-a-l-s_-i-d.html
2929
$dokka.location:io.codemc.api.jenkins//changeJenkinsPassword/#kotlin.String#kotlin.String/PointingToDeclaration/codemc-api/io.codemc.api.jenkins/change-jenkins-password.html
3030
$dokka.location:io.codemc.api.jenkins//checkCredentials/#kotlin.String#kotlin.String/PointingToDeclaration/codemc-api/io.codemc.api.jenkins/check-credentials.html
31+
$dokka.location:io.codemc.api.jenkins//checkUserConfig/#kotlin.String/PointingToDeclaration/codemc-api/io.codemc.api.jenkins/check-user-config.html
3132
$dokka.location:io.codemc.api.jenkins//createJenkinsJob/#kotlin.String#kotlin.String#kotlin.String#kotlin.Boolean#kotlin.Function1[kotlin.String,kotlin.String]/PointingToDeclaration/codemc-api/io.codemc.api.jenkins/create-jenkins-job.html
3233
$dokka.location:io.codemc.api.jenkins//createJenkinsUser/#kotlin.String#kotlin.String/PointingToDeclaration/codemc-api/io.codemc.api.jenkins/create-jenkins-user.html
3334
$dokka.location:io.codemc.api.jenkins//deleteJob/#kotlin.String#kotlin.String/PointingToDeclaration/codemc-api/io.codemc.api.jenkins/delete-job.html
@@ -84,6 +85,7 @@ $dokka.location:io.codemc.api//CREDENTIALS/#/PointingToDeclaration/codemc-api/i
8485
$dokka.location:io.codemc.api//CREDENTIALS_DOMAIN/#/PointingToDeclaration/codemc-api/io.codemc.api/-c-r-e-d-e-n-t-i-a-l-s_-d-o-m-a-i-n.html
8586
$dokka.location:io.codemc.api//JOB_FREESTYLE/#/PointingToDeclaration/codemc-api/io.codemc.api/-j-o-b_-f-r-e-e-s-t-y-l-e.html
8687
$dokka.location:io.codemc.api//JOB_MAVEN/#/PointingToDeclaration/codemc-api/io.codemc.api/-j-o-b_-m-a-v-e-n.html
88+
$dokka.location:io.codemc.api//MAVEN_SETTINGS_XML/#/PointingToDeclaration/codemc-api/io.codemc.api/-m-a-v-e-n_-s-e-t-t-i-n-g-s_-x-m-l.html
8789
$dokka.location:io.codemc.api//RESOURCE_CACHE/#/PointingToDeclaration/codemc-api/io.codemc.api/-r-e-s-o-u-r-c-e_-c-a-c-h-e.html
8890
$dokka.location:io.codemc.api//USER_CONFIG/#/PointingToDeclaration/codemc-api/io.codemc.api/-u-s-e-r_-c-o-n-f-i-g.html
8991
$dokka.location:io.codemc.api//createPassword/#kotlin.Int/PointingToDeclaration/codemc-api/io.codemc.api/create-password.html

0 commit comments

Comments
 (0)