Skip to content

Commit 76237d9

Browse files
CGWebDev2003CGWebDev2003
authored
Merge pull request #16 from CGWebDev2003/main
Added JSDoc Documentation
2 parents fb741fe + ba5e98a commit 76237d9

37 files changed

+13712
-3
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/node_modules/
2+
/out/
23
test.js

‎CHANGELOG.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Released]
99

10-
## [1.0.0] - 2023-05-05
10+
## [1.1.0] - 2023-05-21
11+
12+
### Added
13+
14+
- JSDoc Documentation
15+
16+
## [1.0.0] - 2023-05-20
1117

1218
### Added
1319

‎docs/Badge.html‎

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<title>JSDoc: Class: Badge</title>
6+
7+
<script src="scripts/prettify/prettify.js"> </script>
8+
<script src="scripts/prettify/lang-css.js"> </script>
9+
<!--[if lt IE 9]>
10+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11+
<![endif]-->
12+
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13+
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14+
</head>
15+
16+
<body>
17+
18+
<div id="main">
19+
20+
<h1 class="page-title">Class: Badge</h1>
21+
22+
23+
24+
25+
26+
27+
<section>
28+
29+
<header>
30+
31+
<h2><span class="attribs"><span class="type-signature"></span></span>Badge<span class="signature">(config)</span><span class="type-signature"></span></h2>
32+
33+
34+
</header>
35+
36+
<article>
37+
<div class="container-overview">
38+
39+
40+
41+
42+
43+
44+
<h4 class="name" id="Badge"><span class="type-signature"></span>new Badge<span class="signature">(config)</span><span class="type-signature"></span></h4>
45+
46+
47+
48+
49+
50+
51+
<div class="description">
52+
Create a new Neptune Badge
53+
</div>
54+
55+
56+
57+
58+
59+
60+
61+
62+
63+
<h5>Parameters:</h5>
64+
65+
66+
<table class="params">
67+
<thead>
68+
<tr>
69+
70+
<th>Name</th>
71+
72+
73+
<th>Type</th>
74+
75+
76+
77+
78+
79+
<th class="last">Description</th>
80+
</tr>
81+
</thead>
82+
83+
<tbody>
84+
85+
86+
<tr>
87+
88+
<td class="name"><code>config</code></td>
89+
90+
91+
<td class="type">
92+
93+
94+
<span class="param-type">any</span>
95+
96+
97+
98+
</td>
99+
100+
101+
102+
103+
104+
<td class="description last">Add your configurationparent -> class or id of your target element, when null its document.bodytext -> content of your badgesize -> s, m, lstyle -> primary, accent, information, success, warning, error</td>
105+
</tr>
106+
107+
108+
</tbody>
109+
</table>
110+
111+
112+
113+
114+
115+
116+
<dl class="details">
117+
118+
119+
120+
121+
122+
123+
124+
125+
126+
127+
128+
129+
130+
131+
132+
133+
134+
135+
136+
137+
138+
139+
140+
141+
142+
143+
<dt class="tag-source">Source:</dt>
144+
<dd class="tag-source"><ul class="dummy"><li>
145+
<a href="neptune.js.html">neptune.js</a>, <a href="neptune.js.html#line1">line 1</a>
146+
</li></ul></dd>
147+
148+
149+
150+
151+
152+
153+
154+
</dl>
155+
156+
157+
158+
159+
160+
161+
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
<h5>Example</h5>
175+
176+
<pre class="prettyprint"><code>const myBadge = new Badge({ parent: "#container", text: "My Badge", size: "m", style: "primary"});</code></pre>
177+
178+
179+
180+
181+
</div>
182+
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
193+
194+
195+
196+
197+
198+
199+
200+
201+
202+
</article>
203+
204+
</section>
205+
206+
207+
208+
209+
</div>
210+
211+
<nav>
212+
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Badge.html">Badge</a></li><li><a href="Button.html">Button</a></li><li><a href="Link.html">Link</a></li><li><a href="ProgressBar.html">ProgressBar</a></li><li><a href="Spinner.html">Spinner</a></li><li><a href="Toast.html">Toast</a></li></ul>
213+
</nav>
214+
215+
<br class="clear">
216+
217+
<footer>
218+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Sun May 21 2023 05:13:21 GMT+0200 (Mitteleuropäische Sommerzeit)
219+
</footer>
220+
221+
<script> prettyPrint(); </script>
222+
<script src="scripts/linenumber.js"> </script>
223+
</body>
224+
</html>

0 commit comments

Comments
 (0)