Monado OpenXR Runtime
u_documentation.h
Go to the documentation of this file.
1// Copyright 2019, Collabora, Ltd.
2// SPDX-License-Identifier: BSL-1.0
3/*!
4 * @file
5 * @brief Header with only documentation.
6 * @author Jakob Bornecrantz <jakob@collabora.com>
7 * @ingroup aux_util
8 */
9
10#pragma once
11
12
13/*!
14 * @defgroup aux Auxiliary
15 * @ingroup xrt
16 *
17 * @brief Shared code and helpers for Monado.
18 */
19
20/*!
21 * @defgroup aux_util Utilities
22 * @ingroup aux
23 *
24 * @brief Smaller pieces of auxiliary utilities code.
25 */
26
27
28/*!
29 * @dir src/xrt/auxiliary
30 * @ingroup xrt
31 *
32 * @brief Shared code and helpers for Monado.
33 */
34
35/*!
36 * @dir src/xrt/auxiliary/util
37 * @ingroup aux
38 *
39 * @brief Smaller pieces of auxiliary utilities code.
40 */
41
42#ifdef __cplusplus
43/*!
44 * @brief C++-only APIs in Monado.
45 *
46 * There are not very many of them.
47 */
48namespace xrt {
49
50/*!
51 * @brief C++-only functionality from assorted helper libraries
52 */
53namespace auxiliary {
54
55 /*!
56 * @brief C++-only functionality from the miscellaneous "util" helper library
57 */
58 namespace util {
59 // Empty
60 } // namespace util
61
62} // namespace auxiliary
63
64} // namespace xrt
65
66#endif