Skip to content

Commit

Permalink
Remove table of contents from documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NUCLEAR-BOMB committed Nov 15, 2024
1 parent 24af697 commit 23f73d4
Show file tree
Hide file tree
Showing 5 changed files with 0 additions and 124 deletions.
24 changes: 0 additions & 24 deletions docs/builtin_traits.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,6 @@

# Size optimizations

- [`bool`](#bool)
- [`std::reference_wrapper`](#stdreference_wrapper)
- [`std::pair`](#stdpair)
- [`std::tuple`](#stdtuple)
- [Tuple-like types](#tuple-like-types)
- [`std::array`](#stdarray)
- [Reflectable types](#reflectable-types)
- [Polymorphic types](#polymorphic-types)
- [Pointers](#pointers)
- [Floating point](#floating-point)
- [Reference](#reference)
- [`std::basic_string_view`](#stdbasic_string_view)
- [`std::unique_ptr<T, std::default_delete<T>>`](#stdunique_ptrt-stddefault_deletet)
- [`std::basic_string`](#stdbasic_string)
- [`std::vector`](#stdvector)
- [`SENTINEL` member](#sentinel-member)
- [Enumeration `SENTINEL`](#enumeration-sentinel)
- [Enumeration `SENTINEL_START`](#enumeration-sentinel_start)
- [Enumeration `SENTINEL_START` and `SENTINEL_END`](#enumeration-sentinel_start-and-sentinel_end)
- [Enumeration](#enumeration)
- [Pointers to members](#pointers-to-members)
- [`std::complex`](#stdcomplex)
- [`opt::option`](#optoption)

| Type | max_level | level range |
| :---------------------------------------------- | :------------------------------- | :-------------------------------------- |
| `bool` | 254 | [2,255] |
Expand Down
9 changes: 0 additions & 9 deletions docs/cmake_variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,6 @@ CMake variables that controls build system. See [option][cmake-option].

You can define these variables by providing [`-D`][cmake-d] CMake argument.

- [`OPTION_TEST`](#option_test)
- [`OPTION_EXAMPLES`](#option_examples)
- [`USE_SANITIZER`](#use_sanitizer)
- [`USE_CLANG_TIDY`](#use_clang_tidy)
- [`OPTION_INSTALL`](#option_install)
- [`OPTION_USE_NATVIS`](#option_use_natvis)
- [`OPTION_USE_NATSTEPFILTER`](#option_use_natstepfilter)
- [`USE_LIBASSERT`](#use_libassert)

## `OPTION_TEST`

**default:** [`${PROJECT_IS_TOP_LEVEL}`][is-project-top-level]
Expand Down
9 changes: 0 additions & 9 deletions docs/custom_traits_guide.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@

# Custom option traits guide

- [Custom option traits guide](#custom-option-traits-guide)
- [How `opt::option_traits` affects `opt::option`](#how-optoption_traits-affects-optoption)
- [Creating new `opt::option_traits` specialization](#creating-new-optoption_traits-specialization)
- [Optional static methods](#optional-static-methods)
- [SFINAE](#sfinae)
- [Disabling specializations](#disabling-specializations)
- [Accessing empty state](#accessing-empty-state)
- [Overriding builtin option traits](#overriding-builtin-option-traits)

## How `opt::option_traits` affects `opt::option`

The main purpose of `opt::option_traits` is to redude size of the `opt::option` to absolute minimum.
Expand Down
12 changes: 0 additions & 12 deletions docs/macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,6 @@
> [!WARNING]
> Defining macro that not listed in the following list will possible result code break between different versions.
- [OPTION_USE_QUIET_NAN](#option_use_quiet_nan)
- [OPTION_VERIFY](#option_verify)
- [OPTION_USE_BUILTIN_TRAITS](#option_use_builtin_traits)
- [OPTION_FORWARD_DECLARE_STD](#option_forward_declare_std)
- [OPTION_CONSUMED_ANNOTATION_CHECKING](#option_consumed_annotation_checking)
- [**boost.pfr**/**pfr** library related](#boostpfrpfr-library-related)
- [OPTION_PFR_FILE](#option_pfr_file)
- [OPTION_USE_PFR](#option_use_pfr)
- [**libassert** library related](#libassert-library-related)
- [OPTION_LIBASSERT_FILE](#option_libassert_file)
- [OPTION_USE_LIBASSERT](#option_use_libassert)

### OPTION_USE_QUIET_NAN
*expects:* `boolean`, *default:* `false`

Expand Down
70 changes: 0 additions & 70 deletions docs/reference.md
Original file line number Diff line number Diff line change
@@ -1,76 +1,6 @@

# Reference

- [Declaration](#declaration)
- [Template parameters](#template-parameters)
- [Member types](#member-types)
- [Member functions](#member-functions)
- [Constructor](#constructor)
- [Destructor](#destructor)
- [`operator=`](#operator)
- [`reset`](#reset)
- [`emplace`](#emplace)
- [`try_emplace`](#try_emplace)
- [`has_value`, `operator bool`](#has_value-operator-bool)
- [`has_value_and`](#has_value_and)
- [`take`](#take)
- [`take_if`](#take_if)
- [`inspect`](#inspect)
- [`get`, `operator*`, `operator->`](#get-operator-operator)
- [`get_unchecked`](#get_unchecked)
- [`value`, `value_or_throw`](#value-value_or_throw)
- [`value_or`](#value_or)
- [`value_or_construct`](#value_or_construct)
- [`map_or`](#map_or)
- [`map_or_else`](#map_or_else)
- [`ptr_or_null`](#ptr_or_null)
- [`filter`](#filter)
- [`and_then`](#and_then)
- [`map`](#map)
- [`or_else`](#or_else)
- [`swap`](#swap)
- [`begin`](#begin)
- [`end`](#end)
- [Non-member functions](#non-member-functions)
- [`zip`](#optzip)
- [`zip_with`](#optzip_with)
- [`option_cast`](#optoption_cast)
- [`from_nullable`](#optfrom_nullable)
- [`swap`](#optswap)
- [`get`](#optget)
- [`io`](#optio)
- [`at`](#optat)
- [`at_front`](#optat_front)
- [`at_back`](#optat_back)
- [`flatten`](#optflatten)
- [`unzip`](#optunzip)
- [`lookup`](#optlookup)
- [`operator|`](#operator-1)
- [`operator|=`](#operator-2)
- [`operator&`](#operator-3)
- [`operator^`](#operator-4)
- [`operator==`](#operator-5)
- [`operator!=`](#operator-6)
- [`operator<`](#operator-7)
- [`operator<=`](#operator-8)
- [`operator>`](#operator-9)
- [`operator>=`](#operator-10)
- [Helpers](#Helpers)
- [`std::hash<opt::option>`](#stdhashoptoption)
- [`none_t`](#optnone_t)
- [`none`](#optnone)
- [`bad_access`](#optbad_access)
- [`option_traits`](#optoption_traits)
- [`make_option`](#optmake_option)
- [`is_option`](#optis_option)
- [`option_tag`](#optoption_tag)
- [`sentinel`](#optsentinel)
- [`sentinel_f`](#optsentinel_f)
- [`member`](#optmember)
- [`enforce`](#optenforce)
- [Deduction guides](#deduction-guides)
- [Exposition-only](#exposition-only)

## Declaration

```cpp
Expand Down

0 comments on commit 23f73d4

Please sign in to comment.