Skip to content

Commit b4a9d96

Browse files
committed
website api cosmetics
1 parent 8a2f779 commit b4a9d96

File tree

4 files changed

+4
-5
lines changed

4 files changed

+4
-5
lines changed

include/micro-os-plus/utils/lists.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@
4646
* clients attempt to register is to initialise it during **startup** (via BSS
4747
* initialisation) prior to the execution of static constructors.
4848
*
49-
* Note: For comparison, the original Doxygen html pages, continue to be available
49+
* [Note: For comparison, the original Doxygen html pages, continue to be available
5050
* via the
5151
* <a href="https://micro-os-plus.github.io/utils-lists-xpack/doxygen/index.html">doxygen/\*</a>
52-
* URLs.
52+
* URLs.]
5353
*/
5454

5555
#ifndef MICRO_OS_PLUS_UTILS_LISTS_H_

website/docs/api/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Topics related to the µOS++ Intrusive Lists C API
9797
<p>This approach enables <b>static objects</b> to <b>auto-register</b> with static registrar instances. As the execution order of static constructors is undefined, the only reliable way to ensure the registrar is ready before clients attempt to register is to initialise it during <b>startup</b> (via BSS initialisation) prior to the execution of static constructors.</p>
9898

9999

100-
<p>Note: For comparison, the original Doxygen html pages, continue to be available via the <a href="https://micro-os-plus.github.io/utils-lists-xpack/doxygen/index.html">doxygen/*</a> URLs.</p>
100+
<p>[Note: For comparison, the original Doxygen html pages, continue to be available via the <a href="https://micro-os-plus.github.io/utils-lists-xpack/doxygen/index.html">doxygen/*</a> URLs.]</p>
101101

102102

103103
<hr/>

website/doxygen/xml/indexpage.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<para>A key differentiator from <computeroutput>std::list</computeroutput> is that this implementation <bold>does not require dynamic memory allocation</bold> for list links, thereby eliminating the need for an allocator. Instead, it employs <bold>intrusive lists</bold>, where links are stored directly within the list elements.</para>
1111
<para>Another notable feature is the support for <bold>statically initialised lists</bold>, which can be created in the <bold>global scope</bold> without modifying their members in constructors. These lists are fully <bold>initialised</bold> by setting their entire content to zero during startup (via <bold>BSS initialisation</bold>).</para>
1212
<para>This approach enables <bold>static objects</bold> to <bold>auto-register</bold> with static registrar instances. As the execution order of static constructors is undefined, the only reliable way to ensure the registrar is ready before clients attempt to register is to initialise it during <bold>startup</bold> (via BSS initialisation) prior to the execution of static constructors.</para>
13-
<para>Note: For comparison, the original Doxygen html pages, continue to be available via the <ulink url="https://micro-os-plus.github.io/utils-lists-xpack/doxygen/index.html">doxygen/*</ulink> URLs. </para>
13+
<para>[Note: For comparison, the original Doxygen html pages, continue to be available via the <ulink url="https://micro-os-plus.github.io/utils-lists-xpack/doxygen/index.html">doxygen/*</ulink> URLs.] </para>
1414
</detaileddescription>
1515
<location file="/Users/ilg/MyProjects/micro-os-plus.github/xPacks/utils-lists-xpack.git/include/micro-os-plus/utils/lists.h"/>
1616
</compounddef>

website/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@
5454
"doxygen": "del-cli static/doxygen doxygen/xml; (cd doxygen; doxygen config.doxyfile)",
5555
"browse-doxygen": "open-cli static/doxygen/index.html",
5656
"convert-doxygen": "doxygen2docusaurus",
57-
"generate-doxygen": "docusaurus generate-doxygen",
5857
"generate-website-doxygen": "npm run doxygen && npm run convert-doxygen",
5958
"check-urls": "blc https://micro-os-plus.github.io/utils-lists-xpack/ --recursive --ordered --filter-level 2 --exclude 'https://twitter.com*'",
6059
"docusaurus": "docusaurus",

0 commit comments

Comments
 (0)