Skip to content

Commit 749574c

Browse files
cybercoder-najcybercoder-naj
committed
refactor!: renamed multiLine to multiline
1 parent 40a0ca4 commit 749574c

File tree

5 files changed

+84
-8
lines changed

5 files changed

+84
-8
lines changed

‎core/src/main/kotlin/io/github/cybercodernaj/parkour/lexer/LexerBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ class LexerBuilder internal constructor() {
6868
* ```kt
6969
* val myLexer = lexer {
7070
* // You don't need the square brackets but KDoc doesn't like it...
71-
* multiLineComments(Regex("[/][*]") to Regex("[*][/]"))
71+
* multilineComments(Regex("[/][*]") to Regex("[*][/]"))
7272
* }
7373
* ```
7474
*
@@ -78,7 +78,7 @@ class LexerBuilder internal constructor() {
7878
* @author Nishant Aanjaney Jalan
7979
* @since 0.2.0
8080
*/
81-
fun multiLineComments(multilineComments: Pair<Regex, Regex>) {
81+
fun multilineComments(multilineComments: Pair<Regex, Regex>) {
8282
this.multilineComments = multilineComments
8383
}
8484
}

‎core/src/test/kotlin/io/github/cybercodernaj/parkour/lexer/LexerBuilderTest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class LexerBuilderTest {
4747
@Test
4848
fun `sets multiline comments`() {
4949
val myLexer = lexer {
50-
multiLineComments(Regex("/\\*") to Regex("\\*/"))
50+
multilineComments(Regex("/\\*") to Regex("\\*/"))
5151
}
5252

5353
myLexer.source = StringSource("hi /* hello */\nhru")

‎docs/core/io.github.cybercodernaj.parkour.lexer/-lexer-builder/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,17 @@ <h2 class="">Functions</h2>
8484
</div>
8585
</div>
8686
</div>
87-
<a data-name="1085093360%2FFunctions%2F537371977" anchor-label="multiLineComments" id="1085093360%2FFunctions%2F537371977" data-filterable-set=":core:dokkaHtmlPartial/main"></a>
87+
<a data-name="1044047376%2FFunctions%2F537371977" anchor-label="multilineComments" id="1044047376%2FFunctions%2F537371977" data-filterable-set=":core:dokkaHtmlPartial/main"></a>
8888
<div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/main" data-filterable-set=":core:dokkaHtmlPartial/main">
8989
<div class="main-subrow keyValue ">
9090
<div class=""><span class="inline-flex">
91-
<div><a href="multi-line-comments.html"><span>multi</span><wbr><span>Line</span><wbr><span><span>Comments</span></span></a></div>
92-
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1085093360%2FFunctions%2F537371977"></span>
91+
<div><a href="multiline-comments.html"><span>multiline</span><wbr><span><span>Comments</span></span></a></div>
92+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1044047376%2FFunctions%2F537371977"></span>
9393
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
9494
</span></span></div>
9595
<div>
9696
<div class="title">
97-
<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">fun </span><a href="multi-line-comments.html"><span class="token function">multiLineComments</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">multilineComments<span class="token operator">: </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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">There are two parts to <a href="multi-line-comments.html">multilineComments</a>: the starting and the ending pattern. When the lexer identifies the starting pattern, it will continue to skip to the next possible token until it meets the ending pattern.</p></div></div></div>
97+
<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">fun </span><a href="multiline-comments.html"><span class="token function">multilineComments</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">multilineComments<span class="token operator">: </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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">There are two parts to <a href="multiline-comments.html">multilineComments</a>: the starting and the ending pattern. When the lexer identifies the starting pattern, it will continue to skip to the next possible token until it meets the ending pattern.</p></div></div></div>
9898
</div>
9999
</div>
100100
</div>

‎docs/core/io.github.cybercodernaj.parkour.lexer/-lexer-builder/multiline-comments.html

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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>multilineComments</title>
6+
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg"> <script>var pathToRoot = "../../../";</script>
7+
<script>document.documentElement.classList.replace("no-js","js");</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
if (storage == null) {
10+
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
11+
if (osDarkSchemePreferred === true) {
12+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
13+
}
14+
} else {
15+
const savedDarkMode = JSON.parse(storage)
16+
if(savedDarkMode === true) {
17+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
18+
}
19+
}
20+
</script>
21+
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async></script>
22+
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script>
23+
<link href="../../../styles/style.css" rel="Stylesheet">
24+
<link href="../../../styles/main.css" rel="Stylesheet">
25+
<link href="../../../styles/prism.css" rel="Stylesheet">
26+
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
27+
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
28+
<script type="text/javascript" src="../../../scripts/clipboard.js" async></script>
29+
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async></script>
30+
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async></script>
31+
<script type="text/javascript" src="../../../scripts/main.js" defer></script>
32+
<script type="text/javascript" src="../../../scripts/prism.js" async></script>
33+
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
34+
<body>
35+
<div class="root">
36+
<nav class="navigation" id="navigation-wrapper">
37+
<div class="navigation--inner">
38+
<div class="navigation-title">
39+
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
40+
<div class="library-name">
41+
<a class="library-name--link" href="../../../index.html">
42+
Parkour
43+
</a> </div>
44+
<div class="library-version">0.1.0
45+
</div>
46+
</div>
47+
<div class="filter-section" id="filter-section">
48+
<button class="platform-tag platform-selector jvm-like" data-active="" data-filter=":core:dokkaHtmlPartial/main">jvm</button>
49+
</div>
50+
</div>
51+
<div class="navigation-controls">
52+
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
53+
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
54+
</div>
55+
</nav>
56+
<div id="container">
57+
<div class="sidebar" id="leftColumn">
58+
<div class="sidebar--inner" id="sideMenu"></div>
59+
</div>
60+
<div id="main">
61+
<div class="main-content" data-page-type="member" id="content" pageids="parkour::io.github.cybercodernaj.parkour.lexer/LexerBuilder/multilineComments/#kotlin.Pair[kotlin.text.Regex,kotlin.text.Regex]/PointingToDeclaration//537371977">
62+
<div class="breadcrumbs"><a href="../../index.html">parkour</a><span class="delimiter">/</span><a href="../index.html">io.github.cybercodernaj.parkour.lexer</a><span class="delimiter">/</span><a href="index.html">LexerBuilder</a><span class="delimiter">/</span><span class="current">multilineComments</span></div>
63+
<div class="cover ">
64+
<h1 class="cover"><span>multiline</span><wbr><span><span>Comments</span></span></h1>
65+
</div>
66+
<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">fun </span><a href="multiline-comments.html"><span class="token function">multilineComments</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">multilineComments<span class="token operator">: </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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.html">Regex</a><span class="token operator">&gt;</span></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/lexer/LexerBuilder.kt#L81">source</a>)</span></span></div><p class="paragraph">There are two parts to <a href="multiline-comments.html">multilineComments</a>: the starting and the ending pattern. When the lexer identifies the starting pattern, it will continue to skip to the next possible token until it meets the ending pattern.</p><div class="sample-container"><pre><code class="block lang-kt" theme="idea">val myLexer = lexer {<br> // You don't need the square brackets but KDoc doesn't like it...<br> multilineComments(Regex("[/][*]") to Regex("[*][/]"))<br>}</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">Nishant Aanjaney Jalan</p></span><span class="kdoc-tag"><h4 class="">Since</h4><p class="paragraph">0.2.0</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/main" data-filterable-set=":core:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>single</span><wbr><span>Line</span><wbr><span><span>Comments</span></span></u></div></span></div><div><div class="title"><p class="paragraph">regex of the pattern the lexer will skip over to the next line.</p></div></div></div></div></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":core:dokkaHtmlPartial/main" data-filterable-set=":core:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../io.github.cybercodernaj.parkour.lexer.internal/-lexer/-defaults/single-line-comments.html"><span>Lexer.</span><wbr><span>Defaults.</span><wbr><span>single</span><wbr><span>Line</span><wbr><span><span>Comments</span></span></a></div></span></div><div></div></div></div></div></div></div>
67+
</div>
68+
<div class="footer">
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>
70+
</div>
71+
</div>
72+
</div>
73+
</div>
74+
</body>
75+
</html>
76+

0 commit comments

Comments
 (0)