b_documentation.h

Go to the documentation of this file.

// Copyright 2026, NVIDIA CORPORATION.
// SPDX-License-Identifier: BSL-1.0
/*!
 * @file
 * @brief  Documentation for the base module.
 * @author Jakob Bornecrantz <tbornecrantz@nvidia.com>
 * @ingroup base
 */
 
#pragma once
 
/*!
 * @defgroup base Base implementations
 * @ingroup xrt
 *
 * @brief The base module provide the default implementations of some of the
 * @ref xrt_iface objects, such as the @ref xrt_system and @ref xrt_session.
 * Some of the objects are even extendable by external users of the the Monado
 * codebase. These lives here instead of in other places such as the auxiliary
 * or state tracker modules.
 */
 
/*!
 * @dir src/xrt/base
 * @ingroup base
 *
 * @brief The base module implementation files.
 */