Skip to content

Commit 0ff4b8c

Browse files
committed
updating docs
1 parent 94eab5f commit 0ff4b8c

File tree

7 files changed

+62
-62
lines changed

7 files changed

+62
-62
lines changed

doc/bin-lib/help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# docdown <sup>bde6ac6f7b01bc7ae0862803ca74f01ef76814d9</sup>
1+
# docdown <sup>94eab5f7071c465cff2aefcb55fbfdf608968235</sup>
22

33
<!-- div class="toc-container" -->
44

@@ -20,7 +20,7 @@
2020
<!-- div -->
2121

2222
<h3 id="help"><code>help()</code></h3>
23-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/bde6ac6f7b01bc7ae0862803ca74f01ef76814d9/bin-lib/help.js#L6 "View in source") [&#x24C9;][1]
23+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/bin-lib/help.js#L6 [&#x24C9;][1]
2424

2525
Generates the help text for the docdown cli tool
2626

doc/bin-lib/options.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# docdown <sup>2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9</sup>
1+
# docdown <sup>94eab5f7071c465cff2aefcb55fbfdf608968235</sup>
22

33
<!-- div class="toc-container" -->
44

@@ -34,7 +34,7 @@
3434
<!-- div -->
3535

3636
<h3 id="getoptionname-defaultvalue"><code>getOption(name, defaultValue)</code></h3>
37-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/bin-lib/options.js#L21 "View in source") [&#x24C9;][1]
37+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/bin-lib/options.js#L21 [&#x24C9;][1]
3838

3939
Gets the value for the given option name. If no value is available the
4040
`defaultValue` is returned.
@@ -59,7 +59,7 @@ Gets the value for the given option name. If no value is available the
5959
<!-- div -->
6060

6161
<h3 id="optiontovaluename-string"><code>optionToValue(name, string)</code></h3>
62-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/bin-lib/options.js#L39 "View in source") [&#x24C9;][1]
62+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/bin-lib/options.js#L39 [&#x24C9;][1]
6363

6464
Extracts the option value from an option string.
6565

@@ -83,7 +83,7 @@ Extracts the option value from an option string.
8383
<!-- div -->
8484

8585
<h3 id="result"><code>result</code></h3>
86-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/bin-lib/options.js#L41 "View in source") [&#x24C9;][1]
86+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/bin-lib/options.js#L41 [&#x24C9;][1]
8787

8888

8989

doc/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# docdown <sup>bde6ac6f7b01bc7ae0862803ca74f01ef76814d9</sup>
1+
# docdown <sup>94eab5f7071c465cff2aefcb55fbfdf608968235</sup>
22

33
<!-- div class="toc-container" -->
44

@@ -20,7 +20,7 @@
2020
<!-- div -->
2121

2222
<h3 id="docdownoptions"><code>docdown(options)</code></h3>
23-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/bde6ac6f7b01bc7ae0862803ca74f01ef76814d9/index.js#L26 "View in source") [&#x24C9;][1]
23+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/index.js#L26 [&#x24C9;][1]
2424

2525
Generates Markdown documentation based on JSDoc comments.
2626

doc/lib/alias.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# docdown <sup>2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9</sup>
1+
# docdown <sup>94eab5f7071c465cff2aefcb55fbfdf608968235</sup>
22

33
<!-- div class="toc-container" -->
44

@@ -167,7 +167,7 @@
167167
<!-- div -->
168168

169169
<h3 id="constructorname-owner"><code>constructor(name, owner)</code></h3>
170-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L17 "View in source") [&#x24C9;][1]
170+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L17 [&#x24C9;][1]
171171

172172
The Alias constructor.
173173

@@ -188,7 +188,7 @@ The Alias constructor.
188188
<!-- div -->
189189

190190
<h3 id="getaliasesindex"><code>getAliases([index])</code></h3>
191-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L28 "View in source") [&#x24C9;][1]
191+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L28 [&#x24C9;][1]
192192

193193
Extracts the entry's `alias` objects.
194194

@@ -211,7 +211,7 @@ Extracts the entry's `alias` objects.
211211
<!-- div -->
212212

213213
<h3 id="getcall"><code>getCall()</code></h3>
214-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L37 "View in source") [&#x24C9;][1]
214+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L37 [&#x24C9;][1]
215215

216216
Extracts the function call from the owner entry.
217217

@@ -231,7 +231,7 @@ Extracts the function call from the owner entry.
231231
<!-- div -->
232232

233233
<h3 id="getcategory"><code>getCategory()</code></h3>
234-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L46 "View in source") [&#x24C9;][1]
234+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L46 [&#x24C9;][1]
235235

236236
Extracts the owner entry's `category` data.
237237

@@ -251,7 +251,7 @@ Extracts the owner entry's `category` data.
251251
<!-- div -->
252252

253253
<h3 id="getdesc"><code>getDesc()</code></h3>
254-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L55 "View in source") [&#x24C9;][1]
254+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L55 [&#x24C9;][1]
255255

256256
Extracts the owner entry's description.
257257

@@ -271,7 +271,7 @@ Extracts the owner entry's description.
271271
<!-- div -->
272272

273273
<h3 id="getexample"><code>getExample()</code></h3>
274-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L64 "View in source") [&#x24C9;][1]
274+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L64 [&#x24C9;][1]
275275

276276
Extracts the owner entry's `example` data.
277277

@@ -291,7 +291,7 @@ Extracts the owner entry's `example` data.
291291
<!-- div -->
292292

293293
<h3 id="gethashstyle"><code>getHash([style])</code></h3>
294-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L74 "View in source") [&#x24C9;][1]
294+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L74 [&#x24C9;][1]
295295

296296
Extracts the entry's hash value for permalinking.
297297

@@ -314,7 +314,7 @@ Extracts the entry's hash value for permalinking.
314314
<!-- div -->
315315

316316
<h3 id="getlinenumber"><code>getLineNumber()</code></h3>
317-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L83 "View in source") [&#x24C9;][1]
317+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L83 [&#x24C9;][1]
318318

319319
Resolves the owner entry's line number.
320320

@@ -334,7 +334,7 @@ Resolves the owner entry's line number.
334334
<!-- div -->
335335

336336
<h3 id="getmembersindex"><code>getMembers([index])</code></h3>
337-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L93 "View in source") [&#x24C9;][1]
337+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L93 [&#x24C9;][1]
338338

339339
Extracts the owner entry's `member` data.
340340

@@ -357,7 +357,7 @@ Extracts the owner entry's `member` data.
357357
<!-- div -->
358358

359359
<h3 id="getname"><code>getName()</code></h3>
360-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L102 "View in source") [&#x24C9;][1]
360+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L102 [&#x24C9;][1]
361361

362362
Extracts the owner entry's `name` data.
363363

@@ -377,7 +377,7 @@ Extracts the owner entry's `name` data.
377377
<!-- div -->
378378

379379
<h3 id="getowner"><code>getOwner()</code></h3>
380-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L111 "View in source") [&#x24C9;][1]
380+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L111 [&#x24C9;][1]
381381

382382
Gets the owner entry object.
383383

@@ -397,7 +397,7 @@ Gets the owner entry object.
397397
<!-- div -->
398398

399399
<h3 id="getparamsindex"><code>getParams([index])</code></h3>
400-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L121 "View in source") [&#x24C9;][1]
400+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L121 [&#x24C9;][1]
401401

402402
Extracts the owner entry's `param` data.
403403

@@ -420,7 +420,7 @@ Extracts the owner entry's `param` data.
420420
<!-- div -->
421421

422422
<h3 id="getreturns"><code>getReturns()</code></h3>
423-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L130 "View in source") [&#x24C9;][1]
423+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L130 [&#x24C9;][1]
424424

425425
Extracts the owner entry's `returns` data.
426426

@@ -440,7 +440,7 @@ Extracts the owner entry's `returns` data.
440440
<!-- div -->
441441

442442
<h3 id="getsince"><code>getSince()</code></h3>
443-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L139 "View in source") [&#x24C9;][1]
443+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L139 [&#x24C9;][1]
444444

445445
Extracts the owner entry's `since` data.
446446

@@ -460,7 +460,7 @@ Extracts the owner entry's `since` data.
460460
<!-- div -->
461461

462462
<h3 id="gettype"><code>getType()</code></h3>
463-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L148 "View in source") [&#x24C9;][1]
463+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L148 [&#x24C9;][1]
464464

465465
Extracts the owner entry's `type` data.
466466

@@ -480,7 +480,7 @@ Extracts the owner entry's `type` data.
480480
<!-- div -->
481481

482482
<h3 id="isalias"><code>isAlias()</code></h3>
483-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L157 "View in source") [&#x24C9;][1]
483+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L157 [&#x24C9;][1]
484484

485485
Checks if the entry is an alias.
486486

@@ -500,7 +500,7 @@ Checks if the entry is an alias.
500500
<!-- div -->
501501

502502
<h3 id="isctor"><code>isCtor()</code></h3>
503-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L166 "View in source") [&#x24C9;][1]
503+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L166 [&#x24C9;][1]
504504

505505
Checks if the owner entry is a constructor.
506506

@@ -520,7 +520,7 @@ Checks if the owner entry is a constructor.
520520
<!-- div -->
521521

522522
<h3 id="isfunction"><code>isFunction()</code></h3>
523-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L175 "View in source") [&#x24C9;][1]
523+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L175 [&#x24C9;][1]
524524

525525
Checks if the entry is a function reference.
526526

@@ -540,7 +540,7 @@ Checks if the entry is a function reference.
540540
<!-- div -->
541541

542542
<h3 id="islicense"><code>isLicense()</code></h3>
543-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L184 "View in source") [&#x24C9;][1]
543+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L184 [&#x24C9;][1]
544544

545545
Checks if the owner entry is a license.
546546

@@ -560,7 +560,7 @@ Checks if the owner entry is a license.
560560
<!-- div -->
561561

562562
<h3 id="isplugin"><code>isPlugin()</code></h3>
563-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L193 "View in source") [&#x24C9;][1]
563+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L193 [&#x24C9;][1]
564564

565565
Checks if the owner entry *is* assigned to a prototype.
566566

@@ -580,7 +580,7 @@ Checks if the owner entry *is* assigned to a prototype.
580580
<!-- div -->
581581

582582
<h3 id="isprivate"><code>isPrivate()</code></h3>
583-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L202 "View in source") [&#x24C9;][1]
583+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L202 [&#x24C9;][1]
584584

585585
Checks if the owner entry is private.
586586

@@ -600,7 +600,7 @@ Checks if the owner entry is private.
600600
<!-- div -->
601601

602602
<h3 id="isstatic"><code>isStatic()</code></h3>
603-
[&#x24C8;](https://github.com/satisfactory-dev/docdown/blob/2e7d5a1a1688d0312beedd9bc1f36fe0e8cd44e9/lib/alias.js#L211 "View in source") [&#x24C9;][1]
603+
https://github.com/satisfactory-dev/docdown/blob/94eab5f7071c465cff2aefcb55fbfdf608968235/lib/alias.js#L211 [&#x24C9;][1]
604604

605605
Checks if the owner entry is *not* assigned to a prototype.
606606

0 commit comments

Comments
 (0)