Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@apemsel
apemsel committed Mar 10, 2016
1 parent 4d8ce1f commit 23e905d
Show file tree
Hide file tree
Showing 5 changed files with 224 additions and 218 deletions.
6 changes: 3 additions & 3 deletions doc/class-apemsel.AttributedString.AttributedString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -807,7 +807,7 @@ <h4>Parameters</h4>
</div>
</div></td>
</tr>
<tr data-order="enablebyteToCharCache" id="_enablebyteToCharCache">
<tr data-order="enableByteToCharCache" id="_enableByteToCharCache">

<td class="attributes"><code>
public
Expand All @@ -817,8 +817,8 @@ <h4>Parameters</h4>
</td>

<td class="name"><div>
<a class="anchor" href="#_enablebyteToCharCache">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#399-415" title="Go to source code">enablebyteToCharCache</a>( )</code>
<a class="anchor" href="#_enableByteToCharCache">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#399-415" title="Go to source code">enableByteToCharCache</a>( )</code>

<div class="description short">
<p>Enable and fill cache for byte to char offset conversion</p>
Expand Down
2 changes: 1 addition & 1 deletion doc/class-apemsel.AttributedString.MutableAttributedString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ <h4>Overrides</h4>
<code><a href="class-apemsel.AttributedString.AttributedString.html#_count">count()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_createAttribute">createAttribute()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_deleteAttribute">deleteAttribute()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_enablebyteToCharCache">enablebyteToCharCache()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_enableByteToCharCache">enableByteToCharCache()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_filter">filter()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_hasAttribute">hasAttribute()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_is">is()</a></code>,
Expand Down
42 changes: 21 additions & 21 deletions doc/class-apemsel.AttributedString.TokenizedAttributedString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h1>Class TokenizedAttributedString</h1>

<b>Author:</b>
Adrian Pemsel <a href="&#x6d;&#x61;&#x69;&#x6c;&#116;&#111;&#58;&#97;&#112;&#x65;&#x6d;&#x73;&#x65;&#x6c;&#64;&#103;&#109;&#97;&#105;&#x6c;&#x2e;&#x63;&#x6f;&#x6d;">&#97;&#112;&#x65;&#x6d;&#x73;&#x65;&#x6c;&#64;&#103;&#109;&#97;&#105;&#x6c;&#x2e;&#x63;&#x6f;&#x6d;</a><br>
<b>Located at</b> <a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#4-212" title="Go to source code">TokenizedAttributedString.php</a>
<b>Located at</b> <a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#4-218" title="Go to source code">TokenizedAttributedString.php</a>
<br>
</div>

Expand All @@ -147,7 +147,7 @@ <h1>Class TokenizedAttributedString</h1>

<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#17-34" title="Go to source code">__construct</a>( <span>string|<code><a href="class-apemsel.AttributedString.AttributedString.html">apemsel\AttributedString\AttributedString</a></code> <var>$string</var></span>, <span>string <var>$tokenizer</var> = <span class="php-quote">&quot;whitespace&quot;</span></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#17-40" title="Go to source code">__construct</a>( <span>string|<code><a href="class-apemsel.AttributedString.AttributedString.html">apemsel\AttributedString\AttributedString</a></code> <var>$string</var></span>, <span>string <var>$tokenizer</var> = <span class="php-quote">&quot;whitespace&quot;</span></span> )</code>

<div class="description short">

Expand Down Expand Up @@ -185,7 +185,7 @@ <h4>Overrides</h4>

<td class="name"><div>
<a class="anchor" href="#_getTokens">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#36-43" title="Go to source code">getTokens</a>( )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#42-49" title="Go to source code">getTokens</a>( )</code>

<div class="description short">
<p>Return all tokens</p>
Expand Down Expand Up @@ -218,7 +218,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_getTokenOffsets">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#45-52" title="Go to source code">getTokenOffsets</a>( )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#51-58" title="Go to source code">getTokenOffsets</a>( )</code>

<div class="description short">
<p>Return all tokens' offsets</p>
Expand Down Expand Up @@ -251,7 +251,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_getTokenCount">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#54-61" title="Go to source code">getTokenCount</a>( )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#60-67" title="Go to source code">getTokenCount</a>( )</code>

<div class="description short">
<p>Return the number of tokens</p>
Expand Down Expand Up @@ -284,7 +284,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_getToken">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#63-71" title="Go to source code">getToken</a>( <span>integer <var>$i</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#69-77" title="Go to source code">getToken</a>( <span>integer <var>$i</var></span> )</code>

<div class="description short">
<p>Get indicated token</p>
Expand Down Expand Up @@ -322,7 +322,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_getTokenOffset">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#73-81" title="Go to source code">getTokenOffset</a>( <span>integer <var>$i</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#79-87" title="Go to source code">getTokenOffset</a>( <span>integer <var>$i</var></span> )</code>

<div class="description short">
<p>Get indicated token offset</p>
Expand Down Expand Up @@ -360,7 +360,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_setTokenAttribute">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#83-96" title="Go to source code">setTokenAttribute</a>( <span>integer <var>$i</var></span>, <span>string <var>$attribute</var></span>, <span>boolean <var>$state</var> = <span class="php-keyword1">true</span></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#89-102" title="Go to source code">setTokenAttribute</a>( <span>integer <var>$i</var></span>, <span>string <var>$attribute</var></span>, <span>boolean <var>$state</var> = <span class="php-keyword1">true</span></span> )</code>

<div class="description short">
<p>Set a token to a given attribute and state</p>
Expand Down Expand Up @@ -398,7 +398,7 @@ <h4>Parameters</h4>

<td class="name"><div>
<a class="anchor" href="#_setTokenRangeAttribute">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#98-111" title="Go to source code">setTokenRangeAttribute</a>( <span>integer <var>$from</var></span>, <span>integer <var>$to</var></span>, <span>string <var>$attribute</var></span>, <span>boolean <var>$state</var> = <span class="php-keyword1">true</span></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#104-117" title="Go to source code">setTokenRangeAttribute</a>( <span>integer <var>$from</var></span>, <span>integer <var>$to</var></span>, <span>string <var>$attribute</var></span>, <span>boolean <var>$state</var> = <span class="php-keyword1">true</span></span> )</code>

<div class="description short">
<p>Set a range of tokens to a given attribute and state</p>
Expand Down Expand Up @@ -438,7 +438,7 @@ <h4>Parameters</h4>

<td class="name"><div>
<a class="anchor" href="#_setTokenDictionaryAttribute">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#113-126" title="Go to source code">setTokenDictionaryAttribute</a>( <span>string[] <var>$dictionary</var></span>, <span>string <var>$attribute</var></span>, <span>boolean <var>$state</var> = <span class="php-keyword1">true</span></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#119-132" title="Go to source code">setTokenDictionaryAttribute</a>( <span>string[] <var>$dictionary</var></span>, <span>string <var>$attribute</var></span>, <span>boolean <var>$state</var> = <span class="php-keyword1">true</span></span> )</code>

<div class="description short">
<p>Set all tokens matching given dictionary to attribute and state</p>
Expand Down Expand Up @@ -476,7 +476,7 @@ <h4>Parameters</h4>

<td class="name"><div>
<a class="anchor" href="#_attributesAtToken">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#128-136" title="Go to source code">attributesAtToken</a>( <span>integer <var>$i</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#134-142" title="Go to source code">attributesAtToken</a>( <span>integer <var>$i</var></span> )</code>

<div class="description short">
<p>Get all attribute of token at given index</p>
Expand Down Expand Up @@ -514,7 +514,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_lowercaseTokens">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#138-145" title="Go to source code">lowercaseTokens</a>( )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#144-151" title="Go to source code">lowercaseTokens</a>( )</code>

<div class="description short">
<p>Convert all tokens to lower case</p>
Expand Down Expand Up @@ -543,7 +543,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_tokenizeOnWhitespace">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#147-157" title="Go to source code">tokenizeOnWhitespace</a>( <span>string <var>$string</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#153-163" title="Go to source code">tokenizeOnWhitespace</a>( <span>string <var>$string</var></span> )</code>

<div class="description short">
<p>Tokenize a string on whitespace</p>
Expand All @@ -561,7 +561,7 @@ <h4>Parameters</h4>

<h4>Returns</h4>
<div class="list">
array<br>array of two arrays, with tokens at index 0 and their offsets at index 1
array<br>array of two arrays, with tokens at index 0 and their byte offsets at index 1
</div>


Expand All @@ -581,7 +581,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_tokenizeOnWords">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#159-167" title="Go to source code">tokenizeOnWords</a>( <span>string <var>$string</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#165-173" title="Go to source code">tokenizeOnWords</a>( <span>string <var>$string</var></span> )</code>

<div class="description short">
<p>Tokenize a string on words</p>
Expand All @@ -599,7 +599,7 @@ <h4>Parameters</h4>

<h4>Returns</h4>
<div class="list">
array<br>array of two arrays, with tokens at index 0 and their offsets at index 1
array<br>array of two arrays, with tokens at index 0 and their byte offsets at index 1
</div>


Expand All @@ -619,7 +619,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_tokenizeOnRegex">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#169-187" title="Go to source code">tokenizeOnRegex</a>( <span>string <var>$string</var></span>, <span>string <var>$pattern</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#175-193" title="Go to source code">tokenizeOnRegex</a>( <span>string <var>$string</var></span>, <span>string <var>$pattern</var></span> )</code>

<div class="description short">
<p>Tokenize a string with a given regex</p>
Expand All @@ -639,7 +639,7 @@ <h4>Parameters</h4>

<h4>Returns</h4>
<div class="list">
array<br>array of two arrays, with tokens at index 0 and their offsets at index 1
array<br>array of two arrays, with tokens at index 0 and their byte offsets at index 1
</div>


Expand All @@ -659,7 +659,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_offsetExists">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#191-199" title="Go to source code">offsetExists</a>( <span>integer <var>$i</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#197-205" title="Go to source code">offsetExists</a>( <span>integer <var>$i</var></span> )</code>

<div class="description short">
<p>Check if the token at the given index exists</p>
Expand Down Expand Up @@ -699,7 +699,7 @@ <h4>Overrides</h4>

<td class="name"><div>
<a class="anchor" href="#_offsetGet">#</a>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#201-211" title="Go to source code">offsetGet</a>( <span>integer <var>$i</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.TokenizedAttributedString.html#207-217" title="Go to source code">offsetGet</a>( <span>integer <var>$i</var></span> )</code>

<div class="description short">
<p>Get token at given index</p>
Expand Down Expand Up @@ -746,7 +746,7 @@ <h4>Overrides</h4>
<code><a href="class-apemsel.AttributedString.AttributedString.html#_count">count()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_createAttribute">createAttribute()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_deleteAttribute">deleteAttribute()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_enablebyteToCharCache">enablebyteToCharCache()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_enableByteToCharCache">enableByteToCharCache()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_filter">filter()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_hasAttribute">hasAttribute()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_is">is()</a></code>,
Expand Down
2 changes: 1 addition & 1 deletion doc/source-class-apemsel.AttributedString.AttributedString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ <h3>Classes</h3>
</span></span><span id="401" class="l"><a href="#401">401 </a><span class="php-comment"> *
</span></span><span id="402" class="l"><a href="#402">402 </a><span class="php-comment"> * May improve performance if setPattern is used extensively
</span></span><span id="403" class="l"><a href="#403">403 </a><span class="php-comment"> */</span>
</span><span id="404" class="l"><a href="#404">404 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> enablebyteToCharCache() {
</span><span id="404" class="l"><a href="#404">404 </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> enableByteToCharCache() {
</span><span id="405" class="l"><a href="#405">405 </a> <span class="php-var">$this</span>-&gt;byteToChar = [];
</span><span id="406" class="l"><a href="#406">406 </a> <span class="php-var">$char</span> = <span class="php-num">0</span>;
</span><span id="407" class="l"><a href="#407">407 </a> <span class="php-keyword1">for</span> (<span class="php-var">$i</span> = <span class="php-num">0</span>; <span class="php-var">$i</span> &lt; <span class="php-keyword2">strlen</span>(<span class="php-var">$this</span>-&gt;string); ) {
Expand Down
Loading

0 comments on commit 23e905d

Please sign in to comment.