The topics.h File Reference

Project specific Doxygen topics definitions. More...

Description

Project specific Doxygen topics definitions.

This file defines the principal Doxygen groups and documentation topics for the µTest++ testing framework, which forms 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 a .doxyfile.

The file introduces and organises the main documentation groups for the framework, covering the C++ API, command-line options, expectations, assumptions, comparators, operators, literals, utility functions, and test suite management.

The documentation is structured to provide a comprehensive overview of the framework’s features, usage patterns, and configuration options. It includes detailed explanations, usage examples, and descriptions of the available verbosity modes, along with representative output for various scenarios.

All documentation topics and group definitions are maintained within this file to ensure a consistent and modular structure. The file is located in the website/doxygen folder to facilitate seamless integration with the Doxygen documentation 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 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 docusaurus-plugin-doxygen by Doxygen 1.14.0.