Skip to content

Commit

Permalink
Updates the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mihai-vlc committed Jan 14, 2017
1 parent 6428c38 commit 4ca6a51
Show file tree
Hide file tree
Showing 31 changed files with 223 additions and 166 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ node_modules
.DS_Store
/docs/
/dist/docs/verbal-expressions/*
!/dist/docs/verbal-expressions/0.2.1/
!/dist/docs/verbal-expressions/0.3.0/
.idea/
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2013 jehna
Copyright (c) 2017 jehna

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VerbalExpressions v0.2.1
VerbalExpressions v0.3.0
=====================

[![Build Status](https://travis-ci.org/VerbalExpressions/JSVerbalExpressions.svg)](https://travis-ci.org/VerbalExpressions/JSVerbalExpressions)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -783,7 +783,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -936,7 +936,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -1089,7 +1089,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -1242,7 +1242,7 @@ <h5>Parameters:</h5>

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


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

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


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line228">line 228</a>
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line213">line 213</a>
</li></ul></dd>







</dl>













<h5>Returns:</h5>


<div class="param-desc">
Same instance of VerbalExpression to allow method chaining
</div>



<dl>
<dt>
Type
</dt>
<dd>

<span class="param-type">VerbalExpression</span>


</dd>
</dl>










<h4 class="name" id="digit"><span class="type-signature"></span>digit<span class="signature">()</span><span class="type-signature"> &rarr; {VerbalExpression}</span></h4>





<div class="description">
Any digit
</div>













<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="verbalexpressions.js.html">verbalexpressions.js</a>, <a href="verbalexpressions.js.html#line237">line 237</a>
</li></ul></dd>


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

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


Expand Down Expand Up @@ -1707,7 +1811,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -1860,7 +1964,7 @@ <h5>Parameters:</h5>

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


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

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


Expand Down Expand Up @@ -2117,7 +2221,7 @@ <h5>Parameters:</h5>

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


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

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


Expand Down Expand Up @@ -2374,7 +2478,7 @@ <h5>Parameters:</h5>

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


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

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


Expand Down Expand Up @@ -2631,7 +2735,7 @@ <h5>Parameters:</h5>

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


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

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


Expand Down Expand Up @@ -2911,7 +3015,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -3217,7 +3321,7 @@ <h5>Parameters:</h5>

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


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

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


Expand Down Expand Up @@ -3474,7 +3578,7 @@ <h5>Parameters:</h5>

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


Expand Down Expand Up @@ -3780,7 +3884,7 @@ <h5>Parameters:</h5>

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


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

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


Expand Down Expand Up @@ -4037,7 +4141,7 @@ <h5>Parameters:</h5>

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


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

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


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

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


Expand Down Expand Up @@ -4398,7 +4502,7 @@ <h5>Parameters:</h5>

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


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

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


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

<footer>
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)
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)
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading

0 comments on commit 4ca6a51

Please sign in to comment.