The top-common.h File Reference
Common Doxygen definitions for the µOS++ project. More...
Namespaces Index
| namespace | micro_os_plus |
The primary namespace for the µOS++ framework. More... | |
Description
Common Doxygen definitions for the µOS++ project.
This file provides the principal Doxygen group and namespace documentation for the µOS++ project, serving as a central reference for the project's structure and organisation.
Although named as a header, this file is not included in the build process; it is intended solely as a documentation resource for Doxygen. Due to Doxygen processing requirements, it cannot be supplied as a Markdown file or a .doxyfile.
The file introduces the main documentation group for the µOS++ framework, outlining the overall project structure, which consists of multiple modular source libraries maintained as separate repositories within the micro-os-plus group on GitHub.
Additionally, it documents the micro_os_plus namespace, which acts as the primary scope for all classes, functions, variables, enumerations, type definitions, and related entities within the framework. The namespace is further organised into nested namespaces to promote modularity, reduce redundancy, and enhance maintainability.
All definitions and documentation topics in this file are maintained in the website/doxygen folder to ensure a consistent and modular structure throughout the project's documentation.
File Listing
The file content with the documentation metadata removed is:
Generated via docusaurus-plugin-doxygen by Doxygen 1.13.2