Skip to content

Commit

Permalink
ICU-22723 Update ICU4C API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sven-oly committed Sep 30, 2024
1 parent c20beb8 commit 46b13dd
Show file tree
Hide file tree
Showing 250 changed files with 8,935 additions and 8,505 deletions.
2 changes: 1 addition & 1 deletion apidoc/dev/icu4c/calendar_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a06124aeedc9617528311428f
<div class="ttc" id="autypes_8h_html_ace1704e9e77d407d1eaaa2e73ec0c039"><div class="ttname"><a href="utypes_8h.html#ace1704e9e77d407d1eaaa2e73ec0c039">UDate</a></div><div class="ttdeci">double UDate</div><div class="ttdoc">Date and Time data type.</div><div class="ttdef"><b>Definition</b> <a href="utypes_8h_source.html#l00218">utypes.h:218</a></div></div>
</div><!-- fragment -->
<p>Macro for the class to declare it override haveDefaultCentury, defaultCenturyStart, and defaultCenturyStartYear functions in this class. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000222">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000223">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="calendar_8h_source.html#l02575">2575</a> of file <a class="el" href="calendar_8h_source.html">calendar.h</a>.</p>

Expand Down
6 changes: 3 additions & 3 deletions apidoc/dev/icu4c/classBasicTimeZone.html
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a65086b161e48bb92f382734e
</div><div class="memdoc">

<p>Get time zone offsets from local wall time. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000218">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000219">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

</div>
</div>
Expand Down Expand Up @@ -1109,7 +1109,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a02eb10f55154535df81dab52
</div><div class="memdoc">

<p>A time type option bit mask used by getOffsetFromLocal. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000220">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000221">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="basictz_8h_source.html#l00197">197</a> of file <a class="el" href="basictz_8h_source.html">basictz.h</a>.</p>

Expand All @@ -1136,7 +1136,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae79ae7bf68e441757e8572b9
</div><div class="memdoc">

<p>A time type option bit mask used by getOffsetFromLocal. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000219">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000220">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="basictz_8h_source.html#l00192">192</a> of file <a class="el" href="basictz_8h_source.html">basictz.h</a>.</p>

Expand Down
104 changes: 52 additions & 52 deletions apidoc/dev/icu4c/classCalendar.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions apidoc/dev/icu4c/classChoiceFormat.html
Original file line number Diff line number Diff line change
Expand Up @@ -1116,7 +1116,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8ebee6c4b516d70c47f705e2
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000789">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000790">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#a8ebee6c4b516d70c47f705e2e0d57fe7">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1180,7 +1180,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a58f4eef4daf92cd9538de0a0
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000788">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000789">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#a58f4eef4daf92cd9538de0a0b3ed4901">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1397,7 +1397,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae7ca40f75b85ec4316fa1b75
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000785">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000786">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#ae7ca40f75b85ec4316fa1b75b9a6c872">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1678,7 +1678,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab49822facfd590619cd21c81
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000786">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000787">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#ab49822facfd590619cd21c81175af1fc">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1959,7 +1959,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7005e9ea0f65d9c73a984efe
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000787">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000788">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#a7005e9ea0f65d9c73a984efe0cc21279">icu::NumberFormat</a>.</p>

Expand Down
8 changes: 4 additions & 4 deletions apidoc/dev/icu4c/classCollationElementIterator.html
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9321cc17a1045da222d9745b
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000277">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000278">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="coleitr_8h_source.html#l00297">297</a> of file <a class="el" href="coleitr_8h_source.html">coleitr.h</a>.</p>

Expand Down Expand Up @@ -359,7 +359,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8677b04d7eeb77caef39e1c8
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000276">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000277">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="coleitr_8h_source.html#l00293">293</a> of file <a class="el" href="coleitr_8h_source.html">coleitr.h</a>.</p>

Expand Down Expand Up @@ -920,7 +920,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a8d5b77a1999c429fc47c08f6
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000278">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000279">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="coleitr_8h_source.html#l00301">301</a> of file <a class="el" href="coleitr_8h_source.html">coleitr.h</a>.</p>

Expand Down Expand Up @@ -948,7 +948,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3aaf1a90871ed9740eea5920
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000279">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000280">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="coleitr_8h_source.html#l00305">305</a> of file <a class="el" href="coleitr_8h_source.html">coleitr.h</a>.</p>

Expand Down
16 changes: 8 additions & 8 deletions apidoc/dev/icu4c/classCollator.html
Original file line number Diff line number Diff line change
Expand Up @@ -1283,7 +1283,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#adad32af1dd7138a9048ea130
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000285">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000286">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="coll_8h_source.html#l01240">1240</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>

Expand Down Expand Up @@ -1312,7 +1312,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3bda3d7001538d01841977a2
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000284">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000285">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="coll_8h_source.html#l01236">1236</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>

Expand Down Expand Up @@ -2696,7 +2696,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a04a2abcf663392f926e96b54
</div><div class="memdoc">

<p>Implements <a class="el" href="ucol_8h.html#a85ed590f640f6339d5c9447177e93864" title="Compare two strings in UTF-8.">ucol_strcollUTF8()</a>. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000282">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000283">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a09e4c7e9f2e99a27833df56853e74275">icu::RuleBasedCollator</a>.</p>

Expand Down Expand Up @@ -2766,7 +2766,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#afedd313898b905869c7cd349
<a class="el" href="ucol_8h.html#a4527a9eefdd7e071fff9d87b2e418cfa" title="Verifies and normalizes short definition string.">ucol_normalizeShortDefinitionString</a> </dd>
<dd>
<a class="el" href="ucol_8h.html#a762daeafd0df7cc65fd120a1e802cbbe" title="Get the short definition string for a collator.">ucol_getShortDefinitionString</a> </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000281">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000282">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#aa2069d0a87f3c972ea2661989e7137f3">icu::RuleBasedCollator</a>.</p>

Expand Down Expand Up @@ -2825,7 +2825,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9c6fab32834cce11c5038179
</div><div class="memdoc">

<p>Implements <a class="el" href="ucol_8h.html#a9335659ec3bb470905b4b87059998743" title="Gets the next count bytes of a sort key.">ucol_nextSortKeyPart()</a>. </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000283">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000284">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a927620c85fcbdc2879e23264e499c05a">icu::RuleBasedCollator</a>.</p>

Expand Down Expand Up @@ -3236,7 +3236,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4136c816774f41452426abd9
</table>
</dd>
</dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000280">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000281">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented in <a class="el" href="classicu_1_1RuleBasedCollator.html#a2effd2b9fcd4555ca87657e3fa093ace">icu::RuleBasedCollator</a>.</p>

Expand Down Expand Up @@ -3582,7 +3582,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1e662e22d66640f301e65eca
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000286">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000287">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="coll_8h_source.html#l01244">1244</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>

Expand Down Expand Up @@ -3610,7 +3610,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a73f5f270bc4d114672488859
</tr>
</table>
</div><div class="memdoc">
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000287">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000288">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p class="definition">Definition at line <a class="el" href="coll_8h_source.html#l01248">1248</a> of file <a class="el" href="coll_8h_source.html">coll.h</a>.</p>

Expand Down
12 changes: 6 additions & 6 deletions apidoc/dev/icu4c/classCompactDecimalFormat.html
Original file line number Diff line number Diff line change
Expand Up @@ -977,7 +977,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af44188120533b7966177f723
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000305">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000306">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#a8ebee6c4b516d70c47f705e2e0d57fe7">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1041,7 +1041,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0c9acba7541c860f2905b05d
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000304">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000305">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#a58f4eef4daf92cd9538de0a0b3ed4901">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1160,7 +1160,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7a6d768d679c24621d0000df
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000301">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000302">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#ae7ca40f75b85ec4316fa1b75b9a6c872">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1342,7 +1342,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6ddd1ce7f3e24ee948c1defa
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000302">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000303">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#ab49822facfd590619cd21c81175af1fc">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1524,7 +1524,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a531aab4febb12eeb9535e4c9
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to 'appendTo' parameter. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000303">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000304">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#a7005e9ea0f65d9c73a984efe0cc21279">icu::NumberFormat</a>.</p>

Expand Down Expand Up @@ -1905,7 +1905,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa7d7123641159f497822ec82
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>if parse succeeds, a pointer to a newly-created <a class="el" href="classicu_1_1CurrencyAmount.html" title="A currency together with a numeric amount, such as 200 USD.">CurrencyAmount</a> object (owned by the caller) containing information about the parsed currency; if parse fails, this is nullptr. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000289">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000290">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. </dd></dl>

<p>Reimplemented from <a class="el" href="classicu_1_1NumberFormat.html#aebef744852e384299f206e9ad6b396fa">icu::NumberFormat</a>.</p>

Expand Down
Loading

0 comments on commit 46b13dd

Please sign in to comment.