Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fmtbot committed Jan 19, 2024
1 parent 8d52e95 commit f4a2919
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 3 deletions.
3 changes: 3 additions & 0 deletions dev/_sources/api.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ specified otherwise.
.. doxygenfunction:: print(FILE *f, format_string<T...> fmt, T&&... args)
.. doxygenfunction:: vprint(FILE *f, string_view fmt, format_args args)

.. doxygenfunction:: println(format_string<T...> fmt, T&&... args)
.. doxygenfunction:: println(FILE *f, format_string<T...> fmt, T&&... args)

.. _format:

.. doxygenfunction:: format_to(OutputIt out, format_string<T...> fmt, T&&... args) -> OutputIt
Expand Down
12 changes: 12 additions & 0 deletions dev/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,18 @@
<span id="_CPPv3N3fmt6vprintEP4FILE11string_view11format_args"></span><span id="_CPPv2N3fmt6vprintEP4FILE11string_view11format_args"></span><span id="fmt::vprint__FILEP.string_view.format_args"></span><span class="target" id="base_8h_1a383cc1742196b5c98628592901fa1a56"></span>void <code class="sig-prename descclassname"><a class="reference internal" href="#_CPPv4N3fmt6vprintEP4FILE11string_view11format_args" title="fmt::vprint::fmt">fmt</a><code class="sig-prename descclassname">::</code></code><code class="sig-name descname">vprint</code><span class="sig-paren">(</span>FILE *<em>f</em>, <a class="reference internal" href="#_CPPv4N3fmt11string_viewE" title="fmt::string_view">string_view</a> <em>fmt</em>, <a class="reference internal" href="#_CPPv4N3fmt11format_argsE" title="fmt::format_args">format_args</a> <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3fmt6vprintEP4FILE11string_view11format_args" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt id="_CPPv4IDpEN3fmt7printlnEv13format_stringIDp1TEDpRR1T">
<span id="_CPPv3IDpEN3fmt7printlnE13format_stringIDp1TEDpRR1T"></span><span id="_CPPv2IDpEN3fmt7printlnE13format_stringIDp1TEDpRR1T"></span>template&lt;typename ...<code class="sig-name descname">T</code>&gt;<br /><span class="target" id="base_8h_1a0bc88c34701b1f9afe247df84534f5ab"></span>void <code class="sig-prename descclassname"><a class="reference internal" href="#_CPPv4IDpEN3fmt7printlnEv13format_stringIDp1TEDpRR1T" title="fmt::println::fmt">fmt</a><code class="sig-prename descclassname">::</code></code><code class="sig-name descname">println</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4IDpEN3fmt13format_stringE" title="fmt::format_string">format_string</a>&lt;<a class="reference internal" href="#_CPPv4IDpEN3fmt7printlnEv13format_stringIDp1TEDpRR1T" title="fmt::println::T">T</a>...&gt; <em>fmt</em>, <a class="reference internal" href="#_CPPv4IDpEN3fmt7printlnEv13format_stringIDp1TEDpRR1T" title="fmt::println::T">T</a>&amp;&amp;... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4IDpEN3fmt7printlnEv13format_stringIDp1TEDpRR1T" title="Permalink to this definition"></a><br /></dt>
<dd><p>Formats <code class="docutils literal notranslate"><span class="pre">args</span></code> according to specifications in <code class="docutils literal notranslate"><span class="pre">fmt</span></code> and writes the output to <code class="docutils literal notranslate"><span class="pre">stdout</span></code> followed by a newline. </p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4IDpEN3fmt7printlnEvP4FILE13format_stringIDp1TEDpRR1T">
<span id="_CPPv3IDpEN3fmt7printlnEP4FILE13format_stringIDp1TEDpRR1T"></span><span id="_CPPv2IDpEN3fmt7printlnEP4FILE13format_stringIDp1TEDpRR1T"></span>template&lt;typename ...<code class="sig-name descname">T</code>&gt;<br /><span class="target" id="base_8h_1acbb69219761e15b909f812bf10a2fd75"></span>void <code class="sig-prename descclassname"><a class="reference internal" href="#_CPPv4IDpEN3fmt7printlnEvP4FILE13format_stringIDp1TEDpRR1T" title="fmt::println::fmt">fmt</a><code class="sig-prename descclassname">::</code></code><code class="sig-name descname">println</code><span class="sig-paren">(</span>FILE *<em>f</em>, <a class="reference internal" href="#_CPPv4IDpEN3fmt13format_stringE" title="fmt::format_string">format_string</a>&lt;<a class="reference internal" href="#_CPPv4IDpEN3fmt7printlnEvP4FILE13format_stringIDp1TEDpRR1T" title="fmt::println::T">T</a>...&gt; <em>fmt</em>, <a class="reference internal" href="#_CPPv4IDpEN3fmt7printlnEvP4FILE13format_stringIDp1TEDpRR1T" title="fmt::println::T">T</a>&amp;&amp;... <em>args</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4IDpEN3fmt7printlnEvP4FILE13format_stringIDp1TEDpRR1T" title="Permalink to this definition"></a><br /></dt>
<dd><p>Formats <code class="docutils literal notranslate"><span class="pre">args</span></code> according to specifications in <code class="docutils literal notranslate"><span class="pre">fmt</span></code> and writes the output to the file <code class="docutils literal notranslate"><span class="pre">f</span></code> followed by a newline. </p>
</dd></dl>

<div class="admonition warning" id="format">
<p class="admonition-title">Warning</p>
<p>doxygenfunction: Unable to resolve multiple matches for function “format_to” with arguments ((OutputIt, format_string&lt;T…&gt;, T&amp;&amp;…) -&gt; OutputIt) in doxygen xml output for project “format” from directory: /home/runner/work/fmt/build/doxyxml.
Expand Down
6 changes: 4 additions & 2 deletions dev/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -214,10 +214,10 @@ <h2 id="F">F</h2>
</li>
<li><a href="api.html#_CPPv4N3fmt11format_argsE">fmt::format_args (C++ type)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api.html#_CPPv4N3fmt14format_contextE">fmt::format_context (C++ type)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api.html#_CPPv4IDpEN3fmt13format_stringE">fmt::format_string (C++ type)</a>
</li>
<li><a href="api.html#_CPPv4N3fmt19format_system_errorERN6detail6bufferIcEEiPKc">fmt::format_system_error (C++ function)</a>
Expand Down Expand Up @@ -261,6 +261,8 @@ <h2 id="F">F</h2>
<li><a href="api.html#_CPPv4IDpEN3fmt5printEv13format_stringIDp1TEDpRR1T">fmt::print (C++ function)</a>, <a href="api.html#_CPPv4IDpEN3fmt5printEvP4FILE13format_stringIDp1TEDpRR1T">[1]</a>, <a href="api.html#_CPPv4IDpEN3fmt5printEvRK10text_style13format_stringIDp1TEDpRR1T">[2]</a>, <a href="api.html#_CPPv4IDpEN3fmt5printEvRNSt7ostreamE13format_stringIDp1TEDpRR1T">[3]</a>
</li>
<li><a href="api.html#_CPPv4IDpEN3fmt6printfEi11string_viewDpRK1T">fmt::printf (C++ function)</a>
</li>
<li><a href="api.html#_CPPv4IDpEN3fmt7printlnEv13format_stringIDp1TEDpRR1T">fmt::println (C++ function)</a>, <a href="api.html#_CPPv4IDpEN3fmt7printlnEvP4FILE13format_stringIDp1TEDpRR1T">[1]</a>
</li>
<li><a href="api.html#_CPPv4I0EN3fmt3ptrEPKv1T">fmt::ptr (C++ function)</a>, <a href="api.html#_CPPv4I0EN3fmt3ptrEPKv1T">[1]</a>, <a href="api.html#_CPPv4I0EN3fmt3ptrEPKv1T">[2]</a>
</li>
Expand Down
Binary file modified dev/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion dev/searchindex.js

Large diffs are not rendered by default.

0 comments on commit f4a2919

Please sign in to comment.