doxygen metadata: use explicit os::

micro-os-plus · Dec 6, 2023 · 50df4ec · 50df4ec
1 parent 3f63f33
commit 50df4ec
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/include/micro-os-plus/utils/lists.h b/include/micro-os-plus/utils/lists.h
@@ -794,7 +794,9 @@ namespace micro_os_plus::utils
    * @par Examples
    *
    * @code{.cpp}
-   * using threads_list = utils::intrusive_list<
+   * namespace os = micro_os_plus;
+
+   * using threads_list = os::utils::intrusive_list<
    * thread, utils::double_list_links, &thread::child_links_>;
    * @endcode
    *

diff --git a/website/pages/user-guide.md b/website/pages/user-guide.md
@@ -170,6 +170,8 @@ Here are some excerpts:
 ```cpp
 #include <micro-os-plus/utils/lists.h>
 
+namespace os = micro_os_plus;
+
 class child
 {
 public:
@@ -181,10 +183,10 @@ protected:
 public:
   // Intrusive node used to link this child to the registry list.
   // Must be public.
-  utils::double_list_links registry_links_;
+  os::utils::double_list_links registry_links_;
 };
 
-using static_children_list = utils::intrusive_list<
+using static_children_list = os::utils::intrusive_list<
         child, // type of nodes in the list
         decltype (child::registry_links_), // type of the `registry_links_` member
         &child::registry_links_, // name of member