Skip to content

Commit dca311e

Browse files
apemselapemsel
committed
update documentation
1 parent 9bb1cfd commit dca311e

5 files changed

Lines changed: 238 additions & 176 deletions

‎doc/class-apemsel.AttributedString.AttributedString.html‎

Lines changed: 47 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ <h3>Direct known subclasses</h3>
124124

125125
<b>Author:</b>
126126
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>
127-
<b>Located at</b> <a href="source-class-apemsel.AttributedString.AttributedString.html#4-438" title="Go to source code">AttributedString.php</a>
127+
<b>Located at</b> <a href="source-class-apemsel.AttributedString.AttributedString.html#4-464" title="Go to source code">AttributedString.php</a>
128128
<br>
129129
</div>
130130

@@ -694,7 +694,7 @@ <h4>Returns</h4>
694694

695695
<td class="name"><div>
696696
<a class="anchor" href="#_toHtml">#</a>
697-
<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>
697+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#265-325" 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>
698698

699699
<div class="description short">
700700
<p>Convert to HTML, using a given class to mark attribute spans</p>
@@ -717,10 +717,6 @@ <h4>Returns</h4>
717717
string<br>HTML
718718
</div>
719719

720-
<h4>Throws</h4>
721-
<div class="list">
722-
Exception<br>if the AttributedString cannot be converted to HTML due to improper nesting
723-
</div>
724720

725721

726722

@@ -738,7 +734,7 @@ <h4>Throws</h4>
738734

739735
<td class="name"><div>
740736
<a class="anchor" href="#_combineAttributes">#</a>
741-
<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>
737+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#327-382" 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>
742738

743739
<div class="description short">
744740
<p>Combine attributes with the given boolean operation</p>
@@ -768,6 +764,44 @@ <h4>Throws</h4>
768764

769765

770766

767+
</div>
768+
</div></td>
769+
</tr>
770+
<tr data-order="attributeToString" id="_attributeToString">
771+
772+
<td class="attributes"><code>
773+
public
774+
775+
776+
</code>
777+
</td>
778+
779+
<td class="name"><div>
780+
<a class="anchor" href="#_attributeToString">#</a>
781+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#384-397" title="Go to source code">attributeToString</a>( <span>string <var>$attribute</var></span>, <span>string <var>$true</var> = <span class="php-quote">&quot;-&quot;</span></span>, <span>string <var>$false</var> = <span class="php-quote">&quot; &quot;</span></span> )</code>
782+
783+
<div class="description short">
784+
<p>Convert attribute map to a visual string representation (e.g. for debugging)</p>
785+
</div>
786+
787+
<div class="description detailed hidden">
788+
<p>Convert attribute map to a visual string representation (e.g. for debugging)</p>
789+
790+
791+
<h4>Parameters</h4>
792+
<div class="list"><dl>
793+
<dt><var>$attribute</var></dt>
794+
<dd>name of the attribute</dd>
795+
<dt><var>$true</var></dt>
796+
<dd>char to use for true state of attribute</dd>
797+
<dt><var>$false</var></dt>
798+
<dd>char to use for false state of attribute</dd>
799+
</dl></div>
800+
801+
802+
803+
804+
771805
</div>
772806
</div></td>
773807
</tr>
@@ -782,7 +816,7 @@ <h4>Throws</h4>
782816

783817
<td class="name"><div>
784818
<a class="anchor" href="#_enablebyteToCharCache">#</a>
785-
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#373-389" title="Go to source code">enablebyteToCharCache</a>( )</code>
819+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#399-415" title="Go to source code">enablebyteToCharCache</a>( )</code>
786820

787821
<div class="description short">
788822
<p>Enable and fill cache for byte to char offset conversion</p>
@@ -813,7 +847,7 @@ <h4>Throws</h4>
813847

814848
<td class="name"><div>
815849
<a class="anchor" href="#_byteToCharOffset">#</a>
816-
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#391-395" title="Go to source code">byteToCharOffset</a>( <span> <var>$boff</var></span> )</code>
850+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#417-421" title="Go to source code">byteToCharOffset</a>( <span> <var>$boff</var></span> )</code>
817851

818852
<div class="description short">
819853

@@ -842,7 +876,7 @@ <h4>Throws</h4>
842876

843877
<td class="name"><div>
844878
<a class="anchor" href="#_charToByteOffset">#</a>
845-
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#397-402" title="Go to source code">charToByteOffset</a>( <span> <var>$char</var></span> )</code>
879+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#423-428" title="Go to source code">charToByteOffset</a>( <span> <var>$char</var></span> )</code>
846880

847881
<div class="description short">
848882

@@ -871,7 +905,7 @@ <h4>Throws</h4>
871905

872906
<td class="name"><div>
873907
<a class="anchor" href="#_byteToCharOffsetString">#</a>
874-
<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>
908+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#430-441" title="Go to source code">byteToCharOffsetString</a>( <span> <var>$string</var></span>, <span> <var>$boff</var></span> )</code>
875909

876910
<div class="description short">
877911

@@ -900,7 +934,7 @@ <h4>Throws</h4>
900934

901935
<td class="name"><div>
902936
<a class="anchor" href="#_utf8CharLen">#</a>
903-
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#417-428" title="Go to source code">utf8CharLen</a>( <span> <var>$byte</var></span> )</code>
937+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#443-454" title="Go to source code">utf8CharLen</a>( <span> <var>$byte</var></span> )</code>
904938

905939
<div class="description short">
906940

@@ -929,7 +963,7 @@ <h4>Throws</h4>
929963

930964
<td class="name"><div>
931965
<a class="anchor" href="#_count">#</a>
932-
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#430-437" title="Go to source code">count</a>( )</code>
966+
<code><a href="source-class-apemsel.AttributedString.AttributedString.html#456-463" title="Go to source code">count</a>( )</code>
933967

934968
<div class="description short">
935969
<p>Return string length (number of UTF-8 chars, not strlen())</p>

‎doc/class-apemsel.AttributedString.MutableAttributedString.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,7 @@ <h4>See</h4>
261261
<p class="elementList">
262262
<code><a href="class-apemsel.AttributedString.AttributedString.html#___construct">__construct()</a></code>,
263263
<code><a href="class-apemsel.AttributedString.AttributedString.html#___toString">__toString()</a></code>,
264+
<code><a href="class-apemsel.AttributedString.AttributedString.html#_attributeToString">attributeToString()</a></code>,
264265
<code><a href="class-apemsel.AttributedString.AttributedString.html#_attributesAt">attributesAt()</a></code>,
265266
<code><a href="class-apemsel.AttributedString.AttributedString.html#_byteToCharOffset">byteToCharOffset()</a></code>,
266267
<code><a href="class-apemsel.AttributedString.AttributedString.html#_byteToCharOffsetString">byteToCharOffsetString()</a></code>,

‎doc/class-apemsel.AttributedString.TokenizedAttributedString.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -653,6 +653,7 @@ <h4>Returns</h4>
653653
<div class="panel-heading"><h3>Methods inherited from <a href="class-apemsel.AttributedString.AttributedString.html#methods">apemsel\AttributedString\AttributedString</a></h3></div>
654654
<p class="elementList">
655655
<code><a href="class-apemsel.AttributedString.AttributedString.html#___toString">__toString()</a></code>,
656+
<code><a href="class-apemsel.AttributedString.AttributedString.html#_attributeToString">attributeToString()</a></code>,
656657
<code><a href="class-apemsel.AttributedString.AttributedString.html#_attributesAt">attributesAt()</a></code>,
657658
<code><a href="class-apemsel.AttributedString.AttributedString.html#_byteToCharOffset">byteToCharOffset()</a></code>,
658659
<code><a href="class-apemsel.AttributedString.AttributedString.html#_byteToCharOffsetString">byteToCharOffsetString()</a></code>,

0 commit comments

Comments
 (0)