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 3, 2016
1 parent 3584577 commit 22a6569
Show file tree
Hide file tree
Showing 4 changed files with 334 additions and 202 deletions.
110 changes: 100 additions & 10 deletions doc/class-apemsel.AttributedString.AttributedString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ <h3>Direct known subclasses</h3>

<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.AttributedString.html#4-400" title="Go to source code">AttributedString.php</a>
<b>Located at</b> <a href="source-class-apemsel.AttributedString.AttributedString.html#4-438" title="Go to source code">AttributedString.php</a>
<br>
</div>

Expand Down Expand Up @@ -552,6 +552,96 @@ <h4>Returns</h4>



</div>
</div></td>
</tr>
<tr data-order="substrings" id="_substrings">

<td class="attributes"><code>
public
string[]

</code>
</td>

<td class="name"><div>
<a class="anchor" href="#_substrings">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#209-230" title="Go to source code">substrings</a>( <span>string <var>$attribute</var></span>, <span>integer <var>$offset</var> = <span class="php-num">0</span></span>, <span>boolean <var>$state</var> = <span class="php-keyword1">true</span></span>, <span>boolean <var>$strict</var> = <span class="php-keyword1">true</span></span> )</code>

<div class="description short">
<p>Return an array of substrings that have a given attribute</p>
</div>

<div class="description detailed hidden">
<p>Return an array of substrings that have a given attribute</p>


<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$attribute</var></dt>
<dd>name of the attribute</dd>
<dt><var>$offset</var></dt>
<dd>$pos offset</dd>
<dt><var>$state</var></dt>
<dd>the state to look for (default is true)</dd>
<dt><var>$strict</var></dt>
<dd>perform strict comparison during search</dd>
</dl></div>

<h4>Returns</h4>
<div class="list">
string[]<br>array of strings with given attribute
</div>




</div>
</div></td>
</tr>
<tr data-order="filter" id="_filter">

<td class="attributes"><code>
public
string

</code>
</td>

<td class="name"><div>
<a class="anchor" href="#_filter">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#232-245" title="Go to source code">filter</a>( <span>string <var>$attribute</var></span>, <span>integer <var>$offset</var> = <span class="php-num">0</span></span>, <span>boolean <var>$state</var> = <span class="php-keyword1">true</span></span>, <span>boolean <var>$strict</var> = <span class="php-keyword1">true</span></span>, <span>string <var>$glue</var> = <span class="php-quote">&quot;&quot;</span></span> )</code>

<div class="description short">
<p>Return all parts of the string that have a given attribute as new string</p>
</div>

<div class="description detailed hidden">
<p>Return all parts of the string that have a given attribute as new string</p>


<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$attribute</var></dt>
<dd>name of the attribute</dd>
<dt><var>$offset</var></dt>
<dd>$pos offset</dd>
<dt><var>$state</var></dt>
<dd>the state to look for (default is true)</dd>
<dt><var>$strict</var></dt>
<dd>perform strict comparison during search</dd>
<dt><var>$glue</var></dt>
<dd>glue that is inserted between the parts, default is nothing ("")</dd>
</dl></div>

<h4>Returns</h4>
<div class="list">
string<br>combined filtered string
</div>




</div>
</div></td>
</tr>
Expand All @@ -566,7 +656,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_attributesAt">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#209-225" title="Go to source code">attributesAt</a>( <span>integer <var>$pos</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#247-263" title="Go to source code">attributesAt</a>( <span>integer <var>$pos</var></span> )</code>

<div class="description short">
<p>Return all attributes at a given offset</p>
Expand Down Expand Up @@ -604,7 +694,7 @@ <h4>Returns</h4>

<td class="name"><div>
<a class="anchor" href="#_toHtml">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#227-276" title="Go to source code">toHtml</a>( <span>string <var>$tag</var> = <span class="php-quote">&quot;span&quot;</span></span>, <span>string <var>$classPrefix</var> = <span class="php-quote">&quot;&quot;</span></span> )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#265-314" title="Go to source code">toHtml</a>( <span>string <var>$tag</var> = <span class="php-quote">&quot;span&quot;</span></span>, <span>string <var>$classPrefix</var> = <span class="php-quote">&quot;&quot;</span></span> )</code>

<div class="description short">
<p>Convert to HTML, using a given class to mark attribute spans</p>
Expand Down Expand Up @@ -648,7 +738,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_combineAttributes">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#278-333" title="Go to source code">combineAttributes</a>( <span>string <var>$op</var></span>, <span>string <var>$attribute1</var></span>, <span>string <var>$attribute2</var> = <span class="php-keyword1">false</span></span>, <span>string <var>$to</var> = <span class="php-keyword1">false</span></span> )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#316-371" title="Go to source code">combineAttributes</a>( <span>string <var>$op</var></span>, <span>string <var>$attribute1</var></span>, <span>string <var>$attribute2</var> = <span class="php-keyword1">false</span></span>, <span>string <var>$to</var> = <span class="php-keyword1">false</span></span> )</code>

<div class="description short">
<p>Combine attributes with the given boolean operation</p>
Expand Down Expand Up @@ -692,7 +782,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_enablebyteToCharCache">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#335-351" title="Go to source code">enablebyteToCharCache</a>( )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#373-389" 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 Expand Up @@ -723,7 +813,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_byteToCharOffset">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#353-357" title="Go to source code">byteToCharOffset</a>( <span> <var>$boff</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#391-395" title="Go to source code">byteToCharOffset</a>( <span> <var>$boff</var></span> )</code>

<div class="description short">

Expand Down Expand Up @@ -752,7 +842,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_charToByteOffset">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#359-364" title="Go to source code">charToByteOffset</a>( <span> <var>$char</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#397-402" title="Go to source code">charToByteOffset</a>( <span> <var>$char</var></span> )</code>

<div class="description short">

Expand Down Expand Up @@ -781,7 +871,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_byteToCharOffsetString">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#366-377" title="Go to source code">byteToCharOffsetString</a>( <span> <var>$string</var></span>, <span> <var>$boff</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#404-415" title="Go to source code">byteToCharOffsetString</a>( <span> <var>$string</var></span>, <span> <var>$boff</var></span> )</code>

<div class="description short">

Expand Down Expand Up @@ -810,7 +900,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_utf8CharLen">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#379-390" title="Go to source code">utf8CharLen</a>( <span> <var>$byte</var></span> )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#417-428" title="Go to source code">utf8CharLen</a>( <span> <var>$byte</var></span> )</code>

<div class="description short">

Expand Down Expand Up @@ -839,7 +929,7 @@ <h4>Throws</h4>

<td class="name"><div>
<a class="anchor" href="#_count">#</a>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#392-399" title="Go to source code">count</a>( )</code>
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#430-437" title="Go to source code">count</a>( )</code>

<div class="description short">
<p>Return string length (number of UTF-8 chars, not strlen())</p>
Expand Down
2 changes: 2 additions & 0 deletions doc/class-apemsel.AttributedString.MutableAttributedString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,15 @@ <h4>See</h4>
<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#_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>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_searchAttribute">searchAttribute()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setLength">setLength()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setPattern">setPattern()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setRange">setRange()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setSubstring">setSubstring()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_substrings">substrings()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_toHtml">toHtml()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_utf8CharLen">utf8CharLen()</a></code>
</p>
Expand Down
2 changes: 2 additions & 0 deletions doc/class-apemsel.AttributedString.TokenizedAttributedString.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -662,13 +662,15 @@ <h4>Returns</h4>
<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#_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>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_searchAttribute">searchAttribute()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setLength">setLength()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setPattern">setPattern()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setRange">setRange()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_setSubstring">setSubstring()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_substrings">substrings()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_toHtml">toHtml()</a></code>,
<code><a href="class-apemsel.AttributedString.AttributedString.html#_utf8CharLen">utf8CharLen()</a></code>
</p>
Expand Down
Loading

0 comments on commit 22a6569

Please sign in to comment.