From bc0b3005cfea8fddb2c3166a603e23605a935b2e Mon Sep 17 00:00:00 2001 From: John Wellbelove Date: Tue, 26 May 2026 10:19:37 +0100 Subject: [PATCH] Updates before PR --- docs/containers/arrays/multi-array.md | 1 + docs/containers/lists/_index.md | 6 + docs/containers/{ => lists}/forward-list.md | 1 + .../{ => lists}/intrusive-forward-list.md | 3 +- docs/containers/{ => lists}/intrusive-list.md | 1 + docs/containers/{ => lists}/list.md | 1 + docs/containers/maps/reference-flat-map.md | 4 - docs/containers/memory/_index.md | 6 + .../fixed-sized-memory-block-allocator.md | 0 .../{ => memory}/imemory-block-allocator.md | 0 docs/containers/queues & stacks/_index.md | 6 + .../circular-buffer.md | 0 .../containers/{ => queues & stacks}/deque.md | 0 .../priority-queue.md | 0 .../queue-lockable.md | 0 .../queue-mpmc-mutex.md | 0 .../queue-spsc-atomic.md | 0 .../queue-spsc-isr.md | 0 .../queue-spsc-locked.md | 0 .../{queues => queues & stacks}/queue.md | 0 .../containers/{ => queues & stacks}/stack.md | 0 docs/containers/queues/_index.md | 6 - docs/containers/variadics/_index.md | 6 + docs/containers/{ => variadics}/packet.md | 0 docs/containers/{ => variadics}/tuple.md | 0 .../{ => variadics}/variant-legacy.md | 0 .../{ => variadics}/variant-variadic.md | 0 docs/containers/vectors/_index.md | 6 + .../{ => vectors}/indirect-vector.md | 1 + docs/containers/{ => vectors}/multi-vector.md | 1 + docs/containers/{ => vectors}/vector.md | 1 + docs/page-template.md | 181 ------------------ 32 files changed, 39 insertions(+), 192 deletions(-) create mode 100644 docs/containers/lists/_index.md rename docs/containers/{ => lists}/forward-list.md (99%) rename docs/containers/{ => lists}/intrusive-forward-list.md (98%) rename docs/containers/{ => lists}/intrusive-list.md (99%) rename docs/containers/{ => lists}/list.md (99%) create mode 100644 docs/containers/memory/_index.md rename docs/containers/{ => memory}/fixed-sized-memory-block-allocator.md (100%) rename docs/containers/{ => memory}/imemory-block-allocator.md (100%) create mode 100644 docs/containers/queues & stacks/_index.md rename docs/containers/{queues => queues & stacks}/circular-buffer.md (100%) rename docs/containers/{ => queues & stacks}/deque.md (100%) rename docs/containers/{queues => queues & stacks}/priority-queue.md (100%) rename docs/containers/{queues => queues & stacks}/queue-lockable.md (100%) rename docs/containers/{queues => queues & stacks}/queue-mpmc-mutex.md (100%) rename docs/containers/{queues => queues & stacks}/queue-spsc-atomic.md (100%) rename docs/containers/{queues => queues & stacks}/queue-spsc-isr.md (100%) rename docs/containers/{queues => queues & stacks}/queue-spsc-locked.md (100%) rename docs/containers/{queues => queues & stacks}/queue.md (100%) rename docs/containers/{ => queues & stacks}/stack.md (100%) delete mode 100644 docs/containers/queues/_index.md create mode 100644 docs/containers/variadics/_index.md rename docs/containers/{ => variadics}/packet.md (100%) rename docs/containers/{ => variadics}/tuple.md (100%) rename docs/containers/{ => variadics}/variant-legacy.md (100%) rename docs/containers/{ => variadics}/variant-variadic.md (100%) create mode 100644 docs/containers/vectors/_index.md rename docs/containers/{ => vectors}/indirect-vector.md (99%) rename docs/containers/{ => vectors}/multi-vector.md (98%) rename docs/containers/{ => vectors}/vector.md (99%) delete mode 100644 docs/page-template.md diff --git a/docs/containers/arrays/multi-array.md b/docs/containers/arrays/multi-array.md index e78e50dd..e7a4462b 100644 --- a/docs/containers/arrays/multi-array.md +++ b/docs/containers/arrays/multi-array.md @@ -1,5 +1,6 @@ --- title: "multi_array" +weight: 2 --- {{< callout >}} diff --git a/docs/containers/lists/_index.md b/docs/containers/lists/_index.md new file mode 100644 index 00000000..deeebe4f --- /dev/null +++ b/docs/containers/lists/_index.md @@ -0,0 +1,6 @@ +--- +title: "Lists" +weight: 100 +--- + +List like containers. \ No newline at end of file diff --git a/docs/containers/forward-list.md b/docs/containers/lists/forward-list.md similarity index 99% rename from docs/containers/forward-list.md rename to docs/containers/lists/forward-list.md index 133f4297..b0b358bd 100644 --- a/docs/containers/forward-list.md +++ b/docs/containers/lists/forward-list.md @@ -1,5 +1,6 @@ --- title: "forward_list" +weight: 3 --- {{< callout >}} diff --git a/docs/containers/intrusive-forward-list.md b/docs/containers/lists/intrusive-forward-list.md similarity index 98% rename from docs/containers/intrusive-forward-list.md rename to docs/containers/lists/intrusive-forward-list.md index cf79d69a..81566090 100644 --- a/docs/containers/intrusive-forward-list.md +++ b/docs/containers/lists/intrusive-forward-list.md @@ -1,5 +1,6 @@ --- title: "intrusive_forward_list" +weight: 4 --- {{< callout type="info">}} @@ -7,7 +8,7 @@ title: "intrusive_forward_list" Similar to: `std::forward_list` {{< /callout >}} -An intrusive forward list. +An intrusive forward list.https://www.messenger.com/t/837634551/ ```cpp template diff --git a/docs/containers/intrusive-list.md b/docs/containers/lists/intrusive-list.md similarity index 99% rename from docs/containers/intrusive-list.md rename to docs/containers/lists/intrusive-list.md index 57f6aae3..f0d4cf71 100644 --- a/docs/containers/intrusive-list.md +++ b/docs/containers/lists/intrusive-list.md @@ -1,5 +1,6 @@ --- title: "intrusive_list" +weight: 2 --- {{< callout type="info">}} diff --git a/docs/containers/list.md b/docs/containers/lists/list.md similarity index 99% rename from docs/containers/list.md rename to docs/containers/lists/list.md index 75050fbf..8ae13fd3 100644 --- a/docs/containers/list.md +++ b/docs/containers/lists/list.md @@ -1,5 +1,6 @@ --- title: "list" +weight: 1 --- {{< callout >}} diff --git a/docs/containers/maps/reference-flat-map.md b/docs/containers/maps/reference-flat-map.md index 830345ba..738b7df4 100644 --- a/docs/containers/maps/reference-flat-map.md +++ b/docs/containers/maps/reference-flat-map.md @@ -204,10 +204,6 @@ pair equal_range(const key_type& key) const **Description** Returns the bounds of a range that includes all the elements in the container which have a key equivalent to `key`. -C++11 or above. -For comparators that define `is_transparent`. -Since: `20.21.0` - --- ```cpp diff --git a/docs/containers/memory/_index.md b/docs/containers/memory/_index.md new file mode 100644 index 00000000..df8c06d3 --- /dev/null +++ b/docs/containers/memory/_index.md @@ -0,0 +1,6 @@ +--- +title: "Memory" +weight: 100 +--- + +Memory allocators. \ No newline at end of file diff --git a/docs/containers/fixed-sized-memory-block-allocator.md b/docs/containers/memory/fixed-sized-memory-block-allocator.md similarity index 100% rename from docs/containers/fixed-sized-memory-block-allocator.md rename to docs/containers/memory/fixed-sized-memory-block-allocator.md diff --git a/docs/containers/imemory-block-allocator.md b/docs/containers/memory/imemory-block-allocator.md similarity index 100% rename from docs/containers/imemory-block-allocator.md rename to docs/containers/memory/imemory-block-allocator.md diff --git a/docs/containers/queues & stacks/_index.md b/docs/containers/queues & stacks/_index.md new file mode 100644 index 00000000..c2ef340d --- /dev/null +++ b/docs/containers/queues & stacks/_index.md @@ -0,0 +1,6 @@ +--- +title: "Queues & Stacks" +weight: 100 +--- + +Queue and stack like containers. \ No newline at end of file diff --git a/docs/containers/queues/circular-buffer.md b/docs/containers/queues & stacks/circular-buffer.md similarity index 100% rename from docs/containers/queues/circular-buffer.md rename to docs/containers/queues & stacks/circular-buffer.md diff --git a/docs/containers/deque.md b/docs/containers/queues & stacks/deque.md similarity index 100% rename from docs/containers/deque.md rename to docs/containers/queues & stacks/deque.md diff --git a/docs/containers/queues/priority-queue.md b/docs/containers/queues & stacks/priority-queue.md similarity index 100% rename from docs/containers/queues/priority-queue.md rename to docs/containers/queues & stacks/priority-queue.md diff --git a/docs/containers/queues/queue-lockable.md b/docs/containers/queues & stacks/queue-lockable.md similarity index 100% rename from docs/containers/queues/queue-lockable.md rename to docs/containers/queues & stacks/queue-lockable.md diff --git a/docs/containers/queues/queue-mpmc-mutex.md b/docs/containers/queues & stacks/queue-mpmc-mutex.md similarity index 100% rename from docs/containers/queues/queue-mpmc-mutex.md rename to docs/containers/queues & stacks/queue-mpmc-mutex.md diff --git a/docs/containers/queues/queue-spsc-atomic.md b/docs/containers/queues & stacks/queue-spsc-atomic.md similarity index 100% rename from docs/containers/queues/queue-spsc-atomic.md rename to docs/containers/queues & stacks/queue-spsc-atomic.md diff --git a/docs/containers/queues/queue-spsc-isr.md b/docs/containers/queues & stacks/queue-spsc-isr.md similarity index 100% rename from docs/containers/queues/queue-spsc-isr.md rename to docs/containers/queues & stacks/queue-spsc-isr.md diff --git a/docs/containers/queues/queue-spsc-locked.md b/docs/containers/queues & stacks/queue-spsc-locked.md similarity index 100% rename from docs/containers/queues/queue-spsc-locked.md rename to docs/containers/queues & stacks/queue-spsc-locked.md diff --git a/docs/containers/queues/queue.md b/docs/containers/queues & stacks/queue.md similarity index 100% rename from docs/containers/queues/queue.md rename to docs/containers/queues & stacks/queue.md diff --git a/docs/containers/stack.md b/docs/containers/queues & stacks/stack.md similarity index 100% rename from docs/containers/stack.md rename to docs/containers/queues & stacks/stack.md diff --git a/docs/containers/queues/_index.md b/docs/containers/queues/_index.md deleted file mode 100644 index fae5dc75..00000000 --- a/docs/containers/queues/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Queues" -weight: 100 ---- - -Queue like containers. \ No newline at end of file diff --git a/docs/containers/variadics/_index.md b/docs/containers/variadics/_index.md new file mode 100644 index 00000000..7c051c71 --- /dev/null +++ b/docs/containers/variadics/_index.md @@ -0,0 +1,6 @@ +--- +title: "Variadics" +weight: 100 +--- + +Containers tha accept multiple types. \ No newline at end of file diff --git a/docs/containers/packet.md b/docs/containers/variadics/packet.md similarity index 100% rename from docs/containers/packet.md rename to docs/containers/variadics/packet.md diff --git a/docs/containers/tuple.md b/docs/containers/variadics/tuple.md similarity index 100% rename from docs/containers/tuple.md rename to docs/containers/variadics/tuple.md diff --git a/docs/containers/variant-legacy.md b/docs/containers/variadics/variant-legacy.md similarity index 100% rename from docs/containers/variant-legacy.md rename to docs/containers/variadics/variant-legacy.md diff --git a/docs/containers/variant-variadic.md b/docs/containers/variadics/variant-variadic.md similarity index 100% rename from docs/containers/variant-variadic.md rename to docs/containers/variadics/variant-variadic.md diff --git a/docs/containers/vectors/_index.md b/docs/containers/vectors/_index.md new file mode 100644 index 00000000..40913c33 --- /dev/null +++ b/docs/containers/vectors/_index.md @@ -0,0 +1,6 @@ +--- +title: "Vectors" +weight: 100 +--- + +Vector like containers. \ No newline at end of file diff --git a/docs/containers/indirect-vector.md b/docs/containers/vectors/indirect-vector.md similarity index 99% rename from docs/containers/indirect-vector.md rename to docs/containers/vectors/indirect-vector.md index 0589b0a1..2588f453 100644 --- a/docs/containers/indirect-vector.md +++ b/docs/containers/vectors/indirect-vector.md @@ -1,5 +1,6 @@ --- title: "indirect_vector" +weight: 3 --- {{< callout type="info">}} diff --git a/docs/containers/multi-vector.md b/docs/containers/vectors/multi-vector.md similarity index 98% rename from docs/containers/multi-vector.md rename to docs/containers/vectors/multi-vector.md index 76712af4..be3cfe9a 100644 --- a/docs/containers/multi-vector.md +++ b/docs/containers/vectors/multi-vector.md @@ -1,5 +1,6 @@ --- title: "multi_vector" +weight: 2 --- A fixed capacity multi-dimensional vector. diff --git a/docs/containers/vector.md b/docs/containers/vectors/vector.md similarity index 99% rename from docs/containers/vector.md rename to docs/containers/vectors/vector.md index 5b56a247..216169a7 100644 --- a/docs/containers/vector.md +++ b/docs/containers/vectors/vector.md @@ -1,5 +1,6 @@ --- title: "vector" +weight: 1 --- {{< callout >}} diff --git a/docs/page-template.md b/docs/page-template.md deleted file mode 100644 index fc7ccceb..00000000 --- a/docs/page-template.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -title: "Page Template" -draft: true -weight: 1 ---- - -{{< callout type="info">}} - Header: `my_class.h` - Since: `xx.yy.zz` - Similar to: [Some similar in the STL](https://en.cppreference.com/w/cpp/stl_header.html) -{{< /callout >}} - -A short description of the code this document is about. - -```cpp -The signature of the class, struct, or function -``` - -## Template Parameters - -```cpp -TParameter1 -``` -**Description** -A description the the TParameter1 template parameter. - ---- - -```cpp -TParameter1 -``` -**Description** -A description the the TParameter1 template parameter. - -## Exceptions - -```cpp -etl::your_firt_exception_type -``` -**Description** -Description of what the exception indicates. - -## Member Types - -```cpp -`first_member_type` -``` -**Description** -The first member type - -```cpp -return_type -``` -**Description** -`The second class member type` - -```cpp -argument_types -``` -**Description** - -## Constructors - -`my_class()` - -**Description** -Default constructor. - -**Parameters** -`void` - ---- - -`my_class(const my_class&)` - -**Description** -Copy constructor. - -**Parameters** -Const reference to etl::my_class. - ---- - -`my_class(my_class&&)` - -**Description** -Move constructor. - -**Parameters** -rvalue reference to etl::my_class. - -## Invocation - -```cpp -int operator(float f) -``` -**Description** -Invokes the function operator. - -**Parameters** -`f` The floating point parameter. - -**Returns** -An integer calculated from the float. - ---- - -```cpp -int calculate(float f) -``` -**Description** -Calculates an integer from a float. - -**Parameters** -`f` The floating point parameter. - -**Returns** -An integer calculated from the float. - -## Observers - -```cpp -bool is_valid() const -``` -**Returns** -`true` if the object is valid. - -## Modifiers - -```cpp -void clear() -``` -**Description** -Clears the object. - -**Parameters** -None - -**Returns** -`void` - ---- - -```cpp -void swap(my_class& other) -``` -**Description** -Swaps with another my_class object. - -**Parameters** -A reference to another my_class object. - -**Returns** -`void` - -## Example - -```cpp -#include "etl/my_class.h" - -etl::my_class my_object1; -etl::my_class my_object2; - -int main() -{ - my_object1.swap(my_object2); - - if (my_object.is_valid()) - { - return my_object1(1.23f); - } - else - { - return 0; - } -} -``` - -## Notes - -Some other notes about `etl::my_class`.