topics.h File

Project specific Doxygen topics definitions. More...

Description

Project specific Doxygen topics definitions.

This file organises the principal Doxygen groups and documentation topics for the µTest++ Testing Framework 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 defines the tree and the order of the documentation topics, which is also the order of the sidebar, by including with @include{doc} the hand-written Doxygen sources of the website/doxygen folder: the main page (pages/), the file and folder pages (files/ and folders/), the topics (topics/, with the C++ API topics in topics/cpp-api/), and the configuration macros (macros/).

The text of the topics is not in this file, but in the included files; this page, for example, is files/topics-h.dox, whereas topics.h is in the website/doxygen folder.

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 for any

6 * 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 be

9 * 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.8 by Doxygen 1.18.0.