Updates before PR

This commit is contained in:
John Wellbelove 2026-05-26 10:19:37 +01:00
parent 06c61c9939
commit bc0b3005cf
32 changed files with 39 additions and 192 deletions

View File

@ -1,5 +1,6 @@
---
title: "multi_array"
weight: 2
---
{{< callout >}}

View File

@ -0,0 +1,6 @@
---
title: "Lists"
weight: 100
---
List like containers.

View File

@ -1,5 +1,6 @@
---
title: "forward_list"
weight: 3
---
{{< callout >}}

View File

@ -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 <typename TValue, typename TLink>

View File

@ -1,5 +1,6 @@
---
title: "intrusive_list"
weight: 2
---
{{< callout type="info">}}

View File

@ -1,5 +1,6 @@
---
title: "list"
weight: 1
---
{{< callout >}}

View File

@ -204,10 +204,6 @@ pair<const_iterator, const_iterator> 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

View File

@ -0,0 +1,6 @@
---
title: "Memory"
weight: 100
---
Memory allocators.

View File

@ -0,0 +1,6 @@
---
title: "Queues & Stacks"
weight: 100
---
Queue and stack like containers.

View File

@ -1,6 +0,0 @@
---
title: "Queues"
weight: 100
---
Queue like containers.

View File

@ -0,0 +1,6 @@
---
title: "Variadics"
weight: 100
---
Containers tha accept multiple types.

View File

@ -0,0 +1,6 @@
---
title: "Vectors"
weight: 100
---
Vector like containers.

View File

@ -1,5 +1,6 @@
---
title: "indirect_vector"
weight: 3
---
{{< callout type="info">}}

View File

@ -1,5 +1,6 @@
---
title: "multi_vector"
weight: 2
---
A fixed capacity multi-dimensional vector.

View File

@ -1,5 +1,6 @@
---
title: "vector"
weight: 1
---
{{< callout >}}

View File

@ -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`.