Skip to content

Commit 03f30e0

Browse files
committed
website re-generate doxygen docs
1 parent 061772a commit 03f30e0

14 files changed

+92
-92
lines changed

website/docs/api/classes/micro-os-plus-utils-double-list-iterator.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ The default constructor for <code><Link to="/docs/api/classes/micro-os-plus/util
306306
The internal node pointer is value-initialised (set to <code>nullptr</code>), ensuring that the iterator is safe to use in comparisons and will not dereference an invalid address.
307307
:::
308308

309-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00528">528</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00285">285</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
309+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00528">528</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00285">285</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
310310
</MemberDefinition>
311311

312312
### double&#95;list&#95;iterator() {#a9dcb547fe44a5956040c3c873fa2ae7d}
@@ -322,7 +322,7 @@ Construct an iterator from a node pointer.
322322
</ParametersList>
323323
This constructor creates a <code><Link to="/docs/api/classes/micro-os-plus/utils/double-list-iterator">double&#95;list&#95;iterator</Link></code> that points to the specified node. The internal node pointer is set to the provided node address, allowing the iterator to traverse the list starting from that node. This constructor is typically used to initialise an iterator to a specific position within the list, such as the beginning or end.
324324

325-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00535">535</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00298">298</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
325+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00535">535</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00298">298</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
326326
</MemberDefinition>
327327

328328
### double&#95;list&#95;iterator() {#a03f4f8570751fcfdcd9ad2ad4e1f27d9}
@@ -365,7 +365,7 @@ Pointer to the node.
365365

366366
Returns the internal node pointer that the iterator currently references. This is useful for advanced list operations or when direct access to the underlying node structure is required, such as for interoperability with other list utilities or for debugging purposes.
367367

368-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00634">634</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00455">455</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
368+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00634">634</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00455">455</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
369369
</MemberDefinition>
370370

371371
### get&#95;pointer() {#a4dda1a12bf05e974cc3e6394f28302a0}
@@ -406,7 +406,7 @@ Inequality comparison operator.
406406

407407
The inequality comparison operator (<code>operator!=</code>) checks whether two iterators point to different nodes in the list by comparing their internal node pointers. This is useful for standard iterator operations, such as determining whether an iterator has reached the end of a range or for loop termination conditions.
408408

409-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00614">614</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00440">440</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
409+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00614">614</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00440">440</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
410410
</MemberDefinition>
411411

412412
### operator&#42;() {#a81984e048a2b2778bfd6fd5098a4e7d4}
@@ -425,7 +425,7 @@ The dereference operator (<code>operator&#42;</code>) provides access to the val
425425

426426
This allows the iterator to be used in a manner similar to standard C++ iterators, enabling direct access to the list element for reading or modification.
427427

428-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00562">562</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00343">343</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
428+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00562">562</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00343">343</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
429429
</MemberDefinition>
430430

431431
### operator++() {#a79955aa86c312930d561bfdaa7f8e740}
@@ -442,7 +442,7 @@ Reference to the incremented iterator.
442442

443443
The pre-increment operator (<code>operator++</code>) advances the iterator to the next node in the list. It updates the internal node pointer to point to the node returned by the current node&#39;s <code>next()</code> method. This allows the iterator to traverse the list in the forward direction, following the linked structure.
444444

445-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00570">570</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00358">358</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
445+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00570">570</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00358">358</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
446446
</MemberDefinition>
447447

448448
### operator++() {#a60ce68c08d226be1b5ff5bc92e21a4fc}
@@ -459,7 +459,7 @@ Iterator before increment.
459459

460460
The post-increment operator (<code><Link to="#a60ce68c08d226be1b5ff5bc92e21a4fc">operator++(int)</Link></code>) advances the iterator to the next node in the list, but returns a copy of the iterator as it was before the increment. This allows iteration logic that requires access to the current element before moving to the next one, following the standard C++ iterator semantics for post-increment.
461461

462-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00578">578</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00374">374</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
462+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00578">578</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00374">374</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
463463
</MemberDefinition>
464464

465465
### operator--() {#a511da5b3fb41b18a16d1d04c4f7b1095}
@@ -476,7 +476,7 @@ Reference to the decremented iterator.
476476

477477
The pre-decrement operator (<code>operator--</code>) moves the iterator to the previous node in the list. It updates the internal node pointer to point to the node returned by the current node&#39;s <code>previous</code> pointer. This enables backward traversal of the list, following the linked structure in reverse.
478478

479-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00586">586</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00391">391</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
479+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00586">586</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00391">391</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
480480
</MemberDefinition>
481481

482482
### operator--() {#a1bc00178e8a6da8c816716236fd60be1}
@@ -493,7 +493,7 @@ Iterator before decrement.
493493

494494
The post-decrement operator (<code><Link to="#a1bc00178e8a6da8c816716236fd60be1">operator--(int)</Link></code>) moves the iterator to the previous node in the list, but returns a copy of the iterator as it was before the decrement. This enables iteration logic that requires access to the current element before moving backward, following the standard C++ iterator semantics for post-decrement.
495495

496-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00594">594</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00407">407</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
496+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00594">594</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00407">407</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
497497
</MemberDefinition>
498498

499499
### operator-&gt;() {#a4c59c7d0ddbf8a7e2008d6288a042c08}
@@ -510,7 +510,7 @@ Pointer to the value pointed to by the iterator.
510510

511511
The pointer access operator (<code>operator-&gt;</code>) allows the iterator to provide direct access to the value pointed to by the iterator, mimicking the behavior of a raw pointer. Internally, it calls <code><Link to="#a4dda1a12bf05e974cc3e6394f28302a0">get&#95;pointer()</Link></code>, which computes and returns a pointer to the underlying value or object associated with the current node in the list.
512512

513-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00554">554</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00325">325</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
513+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00554">554</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00325">325</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
514514
</MemberDefinition>
515515

516516
### operator==() {#a4046bc946ebb2d019dac5fd3ffd4d118}
@@ -531,7 +531,7 @@ Equality comparison operator.
531531

532532
The equality comparison operator (<code>operator==</code>) checks whether two iterators point to the same node in the list by comparing their internal node pointers. This allows for standard iterator comparisons, such as detecting the end of a range or verifying if two iterators refer to the same position.
533533

534-
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00604">604</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h/#l00424">424</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link>.
534+
Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h/#l00604">604</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link>, definition at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h/#l00424">424</Link> of file <Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link>.
535535
</MemberDefinition>
536536

537537
</SectionDefinition>
@@ -541,7 +541,7 @@ Declaration at line <Link to="/docs/api/files/include/micro-os-plus/utils/lists-
541541
The documentation for this class was generated from the following files:
542542

543543
<ul>
544-
<li><Link to="/docs/api/files/include/micro-os-plus/utils/inlines-h">inlines.h</Link></li>
544+
<li><Link to="/docs/api/files/include/micro-os-plus/utils/lists-inlines-h">lists-inlines.h</Link></li>
545545
<li><Link to="/docs/api/files/include/micro-os-plus/utils/lists-h">lists.h</Link></li>
546546
</ul>
547547

0 commit comments

Comments
 (0)