Skip to content

Commit 4ca6a51

Browse files
committed
Updates the documentation.
1 parent 6428c38 commit 4ca6a51

31 files changed

+223
-166
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ node_modules
22
.DS_Store
33
/docs/
44
/dist/docs/verbal-expressions/*
5-
!/dist/docs/verbal-expressions/0.2.1/
5+
!/dist/docs/verbal-expressions/0.3.0/
66
.idea/

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2013 jehna
3+
Copyright (c) 2017 jehna
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
VerbalExpressions v0.2.1
1+
VerbalExpressions v0.3.0
22
=====================
33

44
[![Build Status](https://travis-ci.org/VerbalExpressions/JSVerbalExpressions.svg)](https://travis-ci.org/VerbalExpressions/JSVerbalExpressions)

dist/docs/verbal-expressions/0.2.1/VerEx.html renamed to dist/docs/verbal-expressions/0.3.0/VerEx.html

Lines changed: 133 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -630,7 +630,7 @@ <h5>Parameters:</h5>
630630

631631
<dt class="tag-source">Source:</dt>
632632
<dd class="tag-source"><ul class="dummy"><li>
633-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line316">line 316</a>
633+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line303">line 303</a>
634634
</li></ul></dd>
635635

636636

@@ -783,7 +783,7 @@ <h5>Parameters:</h5>
783783

784784
<dt class="tag-source">Source:</dt>
785785
<dd class="tag-source"><ul class="dummy"><li>
786-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line276">line 276</a>
786+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line265">line 265</a>
787787
</li></ul></dd>
788788

789789

@@ -936,7 +936,7 @@ <h5>Parameters:</h5>
936936

937937
<dt class="tag-source">Source:</dt>
938938
<dd class="tag-source"><ul class="dummy"><li>
939-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line264">line 264</a>
939+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line255">line 255</a>
940940
</li></ul></dd>
941941

942942

@@ -1089,7 +1089,7 @@ <h5>Parameters:</h5>
10891089

10901090
<dt class="tag-source">Source:</dt>
10911091
<dd class="tag-source"><ul class="dummy"><li>
1092-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line163">line 163</a>
1092+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line155">line 155</a>
10931093
</li></ul></dd>
10941094

10951095

@@ -1242,7 +1242,7 @@ <h5>Parameters:</h5>
12421242

12431243
<dt class="tag-source">Source:</dt>
12441244
<dd class="tag-source"><ul class="dummy"><li>
1245-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line173">line 173</a>
1245+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line164">line 164</a>
12461246
</li></ul></dd>
12471247

12481248

@@ -1346,7 +1346,7 @@ <h4 class="name" id="beginCapture"><span class="type-signature"></span>beginCapt
13461346

13471347
<dt class="tag-source">Source:</dt>
13481348
<dd class="tag-source"><ul class="dummy"><li>
1349-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line470">line 470</a>
1349+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line426">line 426</a>
13501350
</li></ul></dd>
13511351

13521352

@@ -1450,7 +1450,111 @@ <h4 class="name" id="br"><span class="type-signature"></span>br<span class="sign
14501450

14511451
<dt class="tag-source">Source:</dt>
14521452
<dd class="tag-source"><ul class="dummy"><li>
1453-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line228">line 228</a>
1453+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line213">line 213</a>
1454+
</li></ul></dd>
1455+
1456+
1457+
1458+
1459+
1460+
1461+
1462+
</dl>
1463+
1464+
1465+
1466+
1467+
1468+
1469+
1470+
1471+
1472+
1473+
1474+
1475+
1476+
<h5>Returns:</h5>
1477+
1478+
1479+
<div class="param-desc">
1480+
Same instance of VerbalExpression to allow method chaining
1481+
</div>
1482+
1483+
1484+
1485+
<dl>
1486+
<dt>
1487+
Type
1488+
</dt>
1489+
<dd>
1490+
1491+
<span class="param-type">VerbalExpression</span>
1492+
1493+
1494+
</dd>
1495+
</dl>
1496+
1497+
1498+
1499+
1500+
1501+
1502+
1503+
1504+
1505+
1506+
<h4 class="name" id="digit"><span class="type-signature"></span>digit<span class="signature">()</span><span class="type-signature"> &rarr; {VerbalExpression}</span></h4>
1507+
1508+
1509+
1510+
1511+
1512+
<div class="description">
1513+
Any digit
1514+
</div>
1515+
1516+
1517+
1518+
1519+
1520+
1521+
1522+
1523+
1524+
1525+
1526+
1527+
1528+
<dl class="details">
1529+
1530+
1531+
1532+
1533+
1534+
1535+
1536+
1537+
1538+
1539+
1540+
1541+
1542+
1543+
1544+
1545+
1546+
1547+
1548+
1549+
1550+
1551+
1552+
1553+
1554+
1555+
<dt class="tag-source">Source:</dt>
1556+
<dd class="tag-source"><ul class="dummy"><li>
1557+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line237">line 237</a>
14541558
</li></ul></dd>
14551559

14561560

@@ -1554,7 +1658,7 @@ <h4 class="name" id="endCapture"><span class="type-signature"></span>endCapture<
15541658

15551659
<dt class="tag-source">Source:</dt>
15561660
<dd class="tag-source"><ul class="dummy"><li>
1557-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line482">line 482</a>
1661+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line436">line 436</a>
15581662
</li></ul></dd>
15591663

15601664

@@ -1707,7 +1811,7 @@ <h5>Parameters:</h5>
17071811

17081812
<dt class="tag-source">Source:</dt>
17091813
<dd class="tag-source"><ul class="dummy"><li>
1710-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line117">line 117</a>
1814+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line115">line 115</a>
17111815
</li></ul></dd>
17121816

17131817

@@ -1860,7 +1964,7 @@ <h5>Parameters:</h5>
18601964

18611965
<dt class="tag-source">Source:</dt>
18621966
<dd class="tag-source"><ul class="dummy"><li>
1863-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line142">line 142</a>
1967+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line136">line 136</a>
18641968
</li></ul></dd>
18651969

18661970

@@ -1964,7 +2068,7 @@ <h4 class="name" id="lineBreak"><span class="type-signature"></span>lineBreak<sp
19642068

19652069
<dt class="tag-source">Source:</dt>
19662070
<dd class="tag-source"><ul class="dummy"><li>
1967-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line219">line 219</a>
2071+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line205">line 205</a>
19682072
</li></ul></dd>
19692073

19702074

@@ -2117,7 +2221,7 @@ <h5>Parameters:</h5>
21172221

21182222
<dt class="tag-source">Source:</dt>
21192223
<dd class="tag-source"><ul class="dummy"><li>
2120-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line434">line 434</a>
2224+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line390">line 390</a>
21212225
</li></ul></dd>
21222226

21232227

@@ -2221,7 +2325,7 @@ <h4 class="name" id="oneOrMore"><span class="type-signature"></span>oneOrMore<sp
22212325

22222326
<dt class="tag-source">Source:</dt>
22232327
<dd class="tag-source"><ul class="dummy"><li>
2224-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line422">line 422</a>
2328+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line379">line 379</a>
22252329
</li></ul></dd>
22262330

22272331

@@ -2374,7 +2478,7 @@ <h5>Parameters:</h5>
23742478

23752479
<dt class="tag-source">Source:</dt>
23762480
<dd class="tag-source"><ul class="dummy"><li>
2377-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line454">line 454</a>
2481+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line410">line 410</a>
23782482
</li></ul></dd>
23792483

23802484

@@ -2478,7 +2582,7 @@ <h4 class="name" id="range"><span class="type-signature"></span>range<span class
24782582

24792583
<dt class="tag-source">Source:</dt>
24802584
<dd class="tag-source"><ul class="dummy"><li>
2481-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line284">line 284</a>
2585+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line273">line 273</a>
24822586
</li></ul></dd>
24832587

24842588

@@ -2631,7 +2735,7 @@ <h5>Parameters:</h5>
26312735

26322736
<dt class="tag-source">Source:</dt>
26332737
<dd class="tag-source"><ul class="dummy"><li>
2634-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line331">line 331</a>
2738+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line316">line 316</a>
26352739
</li></ul></dd>
26362740

26372741

@@ -2735,7 +2839,7 @@ <h4 class="name" id="repeatPrevious"><span class="type-signature"></span>repeatP
27352839

27362840
<dt class="tag-source">Source:</dt>
27372841
<dd class="tag-source"><ul class="dummy"><li>
2738-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line393">line 393</a>
2842+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line352">line 352</a>
27392843
</li></ul></dd>
27402844

27412845

@@ -2911,7 +3015,7 @@ <h5>Parameters:</h5>
29113015

29123016
<dt class="tag-source">Source:</dt>
29133017
<dd class="tag-source"><ul class="dummy"><li>
2914-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line207">line 207</a>
3018+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line193">line 193</a>
29153019
</li></ul></dd>
29163020

29173021

@@ -3217,7 +3321,7 @@ <h5>Parameters:</h5>
32173321

32183322
<dt class="tag-source">Source:</dt>
32193323
<dd class="tag-source"><ul class="dummy"><li>
3220-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line377">line 377</a>
3324+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line344">line 344</a>
32213325
</li></ul></dd>
32223326

32233327

@@ -3321,7 +3425,7 @@ <h4 class="name" id="something"><span class="type-signature"></span>something<sp
33213425

33223426
<dt class="tag-source">Source:</dt>
33233427
<dd class="tag-source"><ul class="dummy"><li>
3324-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line184">line 184</a>
3428+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line173">line 173</a>
33253429
</li></ul></dd>
33263430

33273431

@@ -3474,7 +3578,7 @@ <h5>Parameters:</h5>
34743578

34753579
<dt class="tag-source">Source:</dt>
34763580
<dd class="tag-source"><ul class="dummy"><li>
3477-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line194">line 194</a>
3581+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line182">line 182</a>
34783582
</li></ul></dd>
34793583

34803584

@@ -3780,7 +3884,7 @@ <h5>Parameters:</h5>
37803884

37813885
<dt class="tag-source">Source:</dt>
37823886
<dd class="tag-source"><ul class="dummy"><li>
3783-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line360">line 360</a>
3887+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line335">line 335</a>
37843888
</li></ul></dd>
37853889

37863890

@@ -3884,7 +3988,7 @@ <h4 class="name" id="tab"><span class="type-signature"></span>tab<span class="si
38843988

38853989
<dt class="tag-source">Source:</dt>
38863990
<dd class="tag-source"><ul class="dummy"><li>
3887-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line236">line 236</a>
3991+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line221">line 221</a>
38883992
</li></ul></dd>
38893993

38903994

@@ -4037,7 +4141,7 @@ <h5>Parameters:</h5>
40374141

40384142
<dt class="tag-source">Source:</dt>
40394143
<dd class="tag-source"><ul class="dummy"><li>
4040-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line130">line 130</a>
4144+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line126">line 126</a>
40414145
</li></ul></dd>
40424146

40434147

@@ -4141,7 +4245,7 @@ <h4 class="name" id="toRegExp"><span class="type-signature"></span>toRegExp<span
41414245

41424246
<dt class="tag-source">Source:</dt>
41434247
<dd class="tag-source"><ul class="dummy"><li>
4144-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line494">line 494</a>
4248+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line446">line 446</a>
41454249
</li></ul></dd>
41464250

41474251

@@ -4245,7 +4349,7 @@ <h4 class="name" id="whitespace"><span class="type-signature"></span>whitespace<
42454349

42464350
<dt class="tag-source">Source:</dt>
42474351
<dd class="tag-source"><ul class="dummy"><li>
4248-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line254">line 254</a>
4352+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line246">line 246</a>
42494353
</li></ul></dd>
42504354

42514355

@@ -4398,7 +4502,7 @@ <h5>Parameters:</h5>
43984502

43994503
<dt class="tag-source">Source:</dt>
44004504
<dd class="tag-source"><ul class="dummy"><li>
4401-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line343">line 343</a>
4505+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line326">line 326</a>
44024506
</li></ul></dd>
44034507

44044508

@@ -4502,7 +4606,7 @@ <h4 class="name" id="word"><span class="type-signature"></span>word<span class="
45024606

45034607
<dt class="tag-source">Source:</dt>
45044608
<dd class="tag-source"><ul class="dummy"><li>
4505-
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line245">line 245</a>
4609+
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line229">line 229</a>
45064610
</li></ul></dd>
45074611

45084612

@@ -4572,7 +4676,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="VerEx.htm
45724676
<br class="clear">
45734677

45744678
<footer>
4575-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Mar 28 2016 06:30:05 GMT+0300 (FLE Summer Time)
4679+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sat Jan 14 2017 19:00:45 GMT+0200 (GTB Standard Time)
45764680
</footer>
45774681

45784682
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)