Skip to content

Commit f9e05ef

Browse files
vitautvitaut
committed
Deployed bd46586 to dev with MkDocs 1.6.1 and mike 2.1.1
1 parent bd46586 commit f9e05ef

File tree

2 files changed

+32
-32
lines changed

2 files changed

+32
-32
lines changed

‎dev/api/index.html‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,7 @@ <h2 id="base-api">Base API</h2>
777777
<div class="docblock-desc">
778778
<p>Formats <code>args</code> according to specifications in <code>fmt</code> and writes the output to <code>stdout</code>.</p>
779779
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print("The answer is {}.", 42);
780-
</code></pre> </p>
780+
</code> </pre></p>
781781
</div>
782782
</div>
783783
<div class="docblock">
@@ -788,7 +788,7 @@ <h2 id="base-api">Base API</h2>
788788
<div class="docblock-desc">
789789
<p>Formats <code>args</code> according to specifications in <code>fmt</code> and writes the output to the file <code>f</code>.</p>
790790
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print(stderr, "Don't {}!", "panic");
791-
</code></pre> </p>
791+
</code> </pre></p>
792792
</div>
793793
</div>
794794
<div class="docblock">
@@ -818,7 +818,7 @@ <h2 id="base-api">Base API</h2>
818818
<p>Formats <code>args</code> according to specifications in <code>fmt</code>, writes the result to the output iterator <code>out</code> and returns the iterator past the end of the output range. <code>format_to</code> does not append a terminating null character.</p>
819819
<p><b>Example</b>: <pre><code class="language-cpp">auto out = std::vector&lt;char>();
820820
fmt::format_to(std::back_inserter(out), "{}", 42);
821-
</code></pre> </p>
821+
</code> </pre></p>
822822
</div>
823823
</div>
824824
<div class="docblock">
@@ -1083,7 +1083,7 @@ <h3 id="compile-time-checks">Compile-Time Checks</h3>
10831083
<p>Creates a runtime format string.</p>
10841084
<p><b>Example</b>: <pre><code class="language-cpp">// Check format string at runtime instead of compile-time.
10851085
fmt::print(fmt::runtime("{:d}"), "I am not a number");
1086-
</code></pre> </p>
1086+
</code> </pre></p>
10871087
</div>
10881088
</div>
10891089
<h3 id="type-erasure">Type Erasure</h3>
@@ -1126,7 +1126,7 @@ <h3 id="type-erasure">Type Erasure</h3>
11261126
<div class="docblock-desc">
11271127
<p>A view of a collection of formatting arguments. To avoid lifetime issues it should only be used as a parameter type in type-erased functions such as <code>vformat</code>: <pre><code class="language-cpp">void vlog(fmt::string_view fmt, fmt::format_args args); // OK
11281128
fmt::format_args args = fmt::make_format_args(); // Dangling reference
1129-
</code></pre> </p>
1129+
</code> </pre></p>
11301130
<div class="docblock">
11311131
<pre><code class="language-cpp decl"><div></div><div>constexpr basic_format_args(const store&lt;NUM_ARGS, NUM_NAMED_ARGS, DESC>& s);</div></code></pre>
11321132
<div class="docblock-desc">
@@ -1177,7 +1177,7 @@ <h3 id="named-arguments">Named Arguments</h3>
11771177
<div class="docblock-desc">
11781178
<p>Returns a named argument to be used in a formatting function. It should only be used in a call to a formatting function.</p>
11791179
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print("The answer is {answer}.", fmt::arg("answer", 42));
1180-
</code></pre> </p>
1180+
</code> </pre></p>
11811181
</div>
11821182
</div>
11831183
<p>Named arguments are not supported in compile-time checks at the moment.</p>
@@ -1242,7 +1242,7 @@ <h2 id="format-api">Format API</h2>
12421242
<p>Formats <code>args</code> according to specifications in <code>fmt</code> and returns the result as a string.</p>
12431243
<p><b>Example</b>: <pre><code class="language-cpp">#include &lt;fmt/format.h>
12441244
std::string message = fmt::format("The answer is {}.", 42);
1245-
</code></pre> </p>
1245+
</code> </pre></p>
12461246
</div>
12471247
</div>
12481248
<div class="docblock">
@@ -1269,7 +1269,7 @@ <h3 id="utilities">Utilities</h3>
12691269
<div class="docblock-desc">
12701270
<p>Converts <code>p</code> to <code>const void*</code> for pointer formatting.</p>
12711271
<p><b>Example</b>: <pre><code class="language-cpp">auto s = fmt::format("{}", fmt::ptr(p));
1272-
</code></pre> </p>
1272+
</code> </pre></p>
12731273
</div>
12741274
</div>
12751275
<div class="docblock">
@@ -1281,7 +1281,7 @@ <h3 id="utilities">Utilities</h3>
12811281
<p>Converts <code>e</code> to the underlying type.</p>
12821282
<p><b>Example</b>: <pre><code class="language-cpp">enum class color { red, green, blue };
12831283
auto s = fmt::format("{}", fmt::underlying(color::red)); // s == "0"
1284-
</code></pre> </p>
1284+
</code> </pre></p>
12851285
</div>
12861286
</div>
12871287
<div class="docblock">
@@ -1301,7 +1301,7 @@ <h3 id="utilities">Utilities</h3>
13011301
<p>Returns a view that formats an integer value using ',' as a locale-independent thousands separator.</p>
13021302
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print("{}", fmt::group_digits(12345));
13031303
// Output: "12,345"
1304-
</code></pre> </p>
1304+
</code> </pre></p>
13051305
</div>
13061306
</div>
13071307
<div class="docblock">
@@ -1352,7 +1352,7 @@ <h3 id="utilities">Utilities</h3>
13521352
<p>A dynamically growing memory buffer for trivially copyable/constructible types with the first <code>SIZE</code> elements stored in the object itself. Most commonly used via the <code>memory_buffer</code> alias for <code>char</code>.</p>
13531353
<p><b>Example</b>: <pre><code class="language-cpp">auto out = fmt::memory_buffer();
13541354
fmt::format_to(std::back_inserter(out), "The answer is {}.", 42);
1355-
</code></pre> This will append "The answer is 42." to <code>out</code>. The buffer content can be converted to <code>std::string</code> with <code>to_string(out)</code>. </p>
1355+
</code> This will append "The answer is 42." to </pre><code>out</code>. The buffer content can be converted to <code>std::string</code> with <code>to_string(out)</code>. </p>
13561356
<div class="docblock">
13571357
<pre><code class="language-cpp decl"><div></div><div>basic_memory_buffer(basic_memory_buffer&& other);</div></code></pre>
13581358
<div class="docblock-desc">
@@ -1398,7 +1398,7 @@ <h3 id="system-errors">System Errors</h3>
13981398
FILE* file = fopen(filename, "r");
13991399
if (!file)
14001400
throw fmt::system_error(errno, "cannot open file '{}'", filename);
1401-
</code></pre> </p>
1401+
</code> </pre></p>
14021402
</div>
14031403
</div>
14041404
<div class="docblock">
@@ -1407,7 +1407,7 @@ <h3 id="system-errors">System Errors</h3>
14071407
</a>
14081408
<div class="docblock-desc">
14091409
<p>Formats an error message for an error returned by an operating system or a language runtime, for example a file opening error, and writes it to <code>out</code>. The format is the same as the one used by <code>std::system_error(ec, message)</code> where <code>ec</code> is <code>std::error_code(error_code, std::generic_category())</code>. It is implementation-defined but normally looks like: <pre><code class="language-cpp">&lt;message>: &lt;system-message>
1410-
</code></pre> where <code>&lt;message></code> is the passed message and <code>&lt;system-message></code> is the system message corresponding to the error code. <code>error_code</code> is a system error code as given by <code>errno</code>. </p>
1410+
</code> where </pre><code>&lt;message></code> is the passed message and <code>&lt;system-message></code> is the system message corresponding to the error code. <code>error_code</code> is a system error code as given by <code>errno</code>. </p>
14111411
</div>
14121412
</div>
14131413
<h3 id="custom-allocators">Custom Allocators</h3>
@@ -1485,7 +1485,7 @@ <h3 id="legacy-compile-time-checks">Legacy Compile-Time Checks</h3>
14851485
<p>Constructs a legacy compile-time format string from a string literal <code>s</code>.</p>
14861486
<p><b>Example</b>: <pre><code class="language-cpp">// A compile-time error because 'd' is an invalid specifier for strings.
14871487
std::string s = fmt::format(FMT_STRING("{:d}"), "foo");
1488-
</code></pre> </p>
1488+
</code> </pre></p>
14891489
</div>
14901490
</div>
14911491
<p>To force the use of legacy compile-time checks, define the preprocessor
@@ -1514,9 +1514,9 @@ <h2 id="range-and-tuple-formatting">Range and Tuple Formatting</h2>
15141514
<p><b>Example</b>: <pre><code class="language-cpp">auto v = std::vector&lt;int>{1, 2, 3};
15151515
fmt::print("{}", fmt::join(v, ", "));
15161516
// Output: 1, 2, 3
1517-
</code></pre> <code>fmt::join</code> applies passed format specifiers to the range elements: <pre><code class="language-cpp">fmt::print("{:02}", fmt::join(v, ", "));
1517+
</code> </pre><code>fmt::join</code> applies passed format specifiers to the range elements: <pre><code class="language-cpp">fmt::print("{:02}", fmt::join(v, ", "));
15181518
// Output: 01, 02, 03
1519-
</code></pre> </p>
1519+
</code> </pre></p>
15201520
</div>
15211521
</div>
15221522
<div class="docblock">
@@ -1537,7 +1537,7 @@ <h2 id="range-and-tuple-formatting">Range and Tuple Formatting</h2>
15371537
<p>Returns an object that formats <code>std::initializer_list</code> with elements separated by <code>sep</code>.</p>
15381538
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print("{}", fmt::join({1, 2, 3}, ", "));
15391539
// Output: "1, 2, 3"
1540-
</code></pre> </p>
1540+
</code> </pre></p>
15411541
</div>
15421542
</div>
15431543
<p><a id="chrono-api"></a></p>
@@ -1694,7 +1694,7 @@ <h2 id="compile-time-support">Compile-Time Support</h2>
16941694
<p><b>Example</b>: <pre><code class="language-cpp">// Converts 42 into std::string using the most efficient method and no
16951695
// runtime format string processing.
16961696
std::string s = fmt::format(FMT_COMPILE("{}"), 42);
1697-
</code></pre> </p>
1697+
</code> </pre></p>
16981698
</div>
16991699
</div>
17001700
<div class="docblock">
@@ -1707,7 +1707,7 @@ <h2 id="compile-time-support">Compile-Time Support</h2>
17071707
<p><b>Example</b>: <pre><code class="language-cpp">// Produces the static string "42" at compile time.
17081708
static constexpr auto result = FMT_STATIC_FORMAT("{}", 42);
17091709
const char* s = result.c_str();
1710-
</code></pre> </p>
1710+
</code> </pre></p>
17111711
</div>
17121712
</div>
17131713
<p><a id="color-api"></a></p>
@@ -1722,7 +1722,7 @@ <h2 id="terminal-colors-and-text-styles">Terminal Colors and Text Styles</h2>
17221722
<p>Formats a string and prints it to stdout using ANSI escape sequences to specify text formatting.</p>
17231723
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print(fmt::emphasis::bold | fg(fmt::color::red),
17241724
"Elapsed time: {0:.2f} seconds", 1.23);
1725-
</code></pre> </p>
1725+
</code> </pre></p>
17261726
</div>
17271727
</div>
17281728
<div class="docblock">
@@ -1751,7 +1751,7 @@ <h2 id="terminal-colors-and-text-styles">Terminal Colors and Text Styles</h2>
17511751
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print("Elapsed time: {0:.2f} seconds",
17521752
fmt::styled(1.23, fmt::fg(fmt::color::green) |
17531753
fmt::bg(fmt::color::blue)));
1754-
</code></pre> </p>
1754+
</code> </pre></p>
17551755
</div>
17561756
</div>
17571757
<p><a id="os-api"></a></p>
@@ -1778,13 +1778,13 @@ <h2 id="system-apis">System APIs</h2>
17781778
<div class="docblock-desc">
17791779
<p>Opens a file for writing. Supported parameters passed in <code>params</code>:</p>
17801780
<p><ul>
1781-
<li><p><code>&lt;integer></code>: Flags passed to <a href="https://pubs.opengroup.org/onlinepubs/007904875/functions/open.html">open (<code><a href="file::WRONLY">file::WRONLY | <a href="file::CREATE">file::CREATE | <a href="file::TRUNC">file::TRUNC</code> by default)</p>
1781+
<li><p><code>&lt;integer></code>: Flags passed to <a href="https://pubs.opengroup.org/onlinepubs/007904875/functions/open.html">open</a> (<code><a href="file::WRONLY">file::WRONLY</a> | <a href="file::CREATE">file::CREATE</a> | <a href="file::TRUNC">file::TRUNC</a></code> by default)</p>
17821782
</li><li><p><code>buffer_size=&lt;integer></code>: Output buffer size</p>
17831783
</li></ul>
17841784
</p>
17851785
<p><b>Example</b>: <pre><code class="language-cpp">auto out = fmt::output_file("guide.txt");
17861786
out.print("Don't {}", "Panic");
1787-
</code></pre> </p>
1787+
</code> </pre></p>
17881788
</div>
17891789
</div>
17901790
<div class="docblock">
@@ -1794,7 +1794,7 @@ <h2 id="system-apis">System APIs</h2>
17941794
</a>
17951795
<div class="docblock-desc">
17961796
<p>Constructs a <code>std::system_error</code> object with the description of the form <pre><code class="language-cpp">&lt;message>: &lt;system-message>
1797-
</code></pre> where <code>&lt;message></code> is the formatted message and <code>&lt;system-message></code> is the system message corresponding to the error code. <code>error_code</code> is a Windows error code as given by <code>GetLastError</code>. If <code>error_code</code> is not a valid error code such as -1, the system message will look like "error -1".</p>
1797+
</code> where </pre><code>&lt;message></code> is the formatted message and <code>&lt;system-message></code> is the system message corresponding to the error code. <code>error_code</code> is a Windows error code as given by <code>GetLastError</code>. If <code>error_code</code> is not a valid error code such as -1, the system message will look like "error -1".</p>
17981798
<p><b>Example</b>: <pre><code class="language-cpp">// This throws a system_error with the description
17991799
// cannot open file 'foo': The system cannot find the file specified.
18001800
// or similar (system message may vary) if the file doesn't exist.
@@ -1805,7 +1805,7 @@ <h2 id="system-apis">System APIs</h2>
18051805
throw fmt::windows_error(GetLastError(),
18061806
"cannot open file '{}'", filename);
18071807
}
1808-
</code></pre> </p>
1808+
</code> </pre></p>
18091809
</div>
18101810
</div>
18111811
<p><a id="ostream-api"></a></p>
@@ -1838,7 +1838,7 @@ <h2 id="stdostream-support"><code>std::ostream</code> Support</h2>
18381838
<p>Returns a view that formats <code>value</code> via an ostream <code>operator&lt;&lt;</code>.</p>
18391839
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print("Current thread id: {}\n",
18401840
fmt::streamed(std::this_thread::get_id()));
1841-
</code></pre> </p>
1841+
</code> </pre></p>
18421842
</div>
18431843
</div>
18441844
<div class="docblock">
@@ -1849,7 +1849,7 @@ <h2 id="stdostream-support"><code>std::ostream</code> Support</h2>
18491849
<div class="docblock-desc">
18501850
<p>Prints formatted data to the stream <code>os</code>.</p>
18511851
<p><b>Example</b>: <pre><code class="language-cpp">fmt::print(cerr, "Don't {}!", "panic");
1852-
</code></pre> </p>
1852+
</code> </pre></p>
18531853
</div>
18541854
</div>
18551855
<p><a id="args-api"></a></p>
@@ -1874,7 +1874,7 @@ <h2 id="dynamic-argument-lists">Dynamic Argument Lists</h2>
18741874
store.push_back("abc");
18751875
store.push_back(1.5f);
18761876
std::string result = fmt::vformat("{} and {} and {}", store);
1877-
</code></pre> </p>
1877+
</code> </pre></p>
18781878
</div>
18791879
</div>
18801880
<div class="docblock">
@@ -1887,7 +1887,7 @@ <h2 id="dynamic-argument-lists">Dynamic Argument Lists</h2>
18871887
band[9] = 'c'; // Changing str affects the output.
18881888
std::string result = fmt::vformat("{}", store);
18891889
// result == "Rolling Scones"
1890-
</code></pre> </p>
1890+
</code> </pre></p>
18911891
</div>
18921892
</div>
18931893
<div class="docblock">
@@ -1943,7 +1943,7 @@ <h2 id="safe-printf">Safe <code>printf</code></h2>
19431943
<div class="docblock-desc">
19441944
<p>Formats <code>args</code> according to specifications in <code>fmt</code> and writes the output to <code>f</code>.</p>
19451945
<p><b>Example</b>: <pre><code class="language-cpp">fmt::fprintf(stderr, "Don't %s!", "panic");
1946-
</code></pre> </p>
1946+
</code> </pre></p>
19471947
</div>
19481948
</div>
19491949
<div class="docblock">
@@ -1954,7 +1954,7 @@ <h2 id="safe-printf">Safe <code>printf</code></h2>
19541954
<div class="docblock-desc">
19551955
<p>Formats <code>args</code> according to specifications in <code>fmt</code> and returns the result as as string.</p>
19561956
<p><b>Example</b>: <pre><code class="language-cpp">std::string message = fmt::sprintf("The answer is %d", 42);
1957-
</code></pre> </p>
1957+
</code> </pre></p>
19581958
</div>
19591959
</div>
19601960
<p><a id="xchar-api"></a></p>

‎dev/search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)