topics.h File

Project specific Doxygen topics definitions. More...

Description

Project specific Doxygen topics definitions.

This file serves as the main entry point for the Doxygen documentation of the µOS++ Intrusive Lists utilities. It organizes and includes the documentation topics, file and folder references, and API groups that make up the structure of the generated documentation. The order of the @include directives determines the order of sections in the sidebar and navigation. This file ensures that users can easily explore the available modules, APIs, and supporting information for the utilities package.

This file organises the principal Doxygen groups and documentation topics for the µOS++ Intrusive Lists library, which is part of the µOS++ project.

Although named as a header, this file is not included in the build process; it is intended exclusively as a documentation resource for Doxygen. Due to Doxygen processing requirements, it cannot be provided as a Markdown file or as a .doxyfile.

It introduces and organises the main documentation groups for the library, covering the C++ API.

The documentation is structured to provide a comprehensive overview of the library's features, usage patterns, and configuration options. It includes detailed explanations, usage examples for various scenarios.

All documentation topics and group definitions are maintained in this file to ensure a consistent and modular structure. The file is located in the website/doxygen/files folder to facilitate integration with the Doxygen system.

File Listing

The file content with the documentation metadata removed is:

1/*

2 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).

3 * Copyright (c) 2021-2026 Liviu Ionescu. All rights reserved.

4 *

5 * Permission to use, copy, modify, and/or distribute this software

6 * for any purpose is hereby granted, under the terms of the MIT license.

7 *

8 * If a copy of the license was not distributed with this file, it can

9 * be obtained from https://opensource.org/licenses/mit.

10 */

11

12/*

13 * Note: the order is important, it also gives the order in the sidebar.

14 */

15

---

Generated via doxygen2docusaurus 2.2.2 by Doxygen 1.17.0.