coffee/better-enums
1
0
Fork 0
mirror of https://github.com/aantron/better-enums.git synced 2025-12-06 16:56:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: fix rendering of <Enum>

Browse Source 
[skip ci]
This commit is contained in:
Anton Bachin 2020-10-19 08:12:51 +03:00
parent 3e115c0c17
commit 2f1fcaae7a
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/ApiReference.md
View File

@ -228,7 +228,7 @@ If the given string is the exact name of a declared constant, returns the
constant. Otherwise, throws `std::runtime_error`. Running time is linear in the constant. Otherwise, throws `std::runtime_error`. Running time is linear in the
number of declared constants multiplied by the length of the longest constant. number of declared constants multiplied by the length of the longest constant.
#### static constexpr optional<Enum> <em>_from_string_nothrow</em>(const char*) #### static constexpr optional&lt;Enum&gt; <em>_from_string_nothrow</em>(const char*)
Same as [`_from_string`](#_from_string), but does not throw an exception on Same as [`_from_string`](#_from_string), but does not throw an exception on
failure. Returns an [optional value](#StructBetter_enumsoptional) instead. failure. Returns an [optional value](#StructBetter_enumsoptional) instead.
@ -238,7 +238,7 @@ failure. Returns an [optional value](#StructBetter_enumsoptional) instead.
Same as [`_from_string`](#_from_string), but comparison is up to case, in the Same as [`_from_string`](#_from_string), but comparison is up to case, in the
usual sense in the Latin-1 encoding. usual sense in the Latin-1 encoding.
#### static constexpr optional<Enum> <em>_from_string_nocase_nothrow</em>(const char*) #### static constexpr optional&lt;Enum&gt; <em>_from_string_nocase_nothrow</em>(const char*)
Is to [`_from_string_nocase`](#_from_string_nocase) as Is to [`_from_string_nocase`](#_from_string_nocase) as
[`_from_string_nothrow`](#_from_string_nothrow) is to [`_from_string_nothrow`](#_from_string_nothrow) is to
@ -342,7 +342,7 @@ of one of the declared constants.
<em>Enum::_from_integral</em>(<em>2</em>); // Enum::C <em>Enum::_from_integral</em>(<em>2</em>); // Enum::C
<em>Enum::_from_integral</em>(<em>42</em>); // std::runtime_error <em>Enum::_from_integral</em>(<em>42</em>); // std::runtime_error
#### static constexpr optional<Enum> <em>_from_integral_nothrow</em>(_integral) #### static constexpr optional&lt;Enum&gt; <em>_from_integral_nothrow</em>(_integral)
Checked conversion as [`_from_integral`](#_from_integral), but does not throw an Checked conversion as [`_from_integral`](#_from_integral), but does not throw an
exception on failure. Returns an [optional value](#StructBetter_enumsoptional) exception on failure. Returns an [optional value](#StructBetter_enumsoptional)
@ -392,7 +392,7 @@ Returns the value of the constant with the given index. Throws
Returns the value of the constant with the given index. If not given one of the Returns the value of the constant with the given index. If not given one of the
constants in the declaration of the enum, the returned value is undefined. constants in the declaration of the enum, the returned value is undefined.
#### static constexpr optional<Enum> <em>_from_index_nothrow</em>(size_t) #### static constexpr optional&lt;Enum&gt; <em>_from_index_nothrow</em>(size_t)
Returns the value of the constant with the given index. Returns the value of the constant with the given index.