diff --git a/src/xrt/drivers/hdk/hdk_device.cpp b/src/xrt/drivers/hdk/hdk_device.cpp index b163a1945..9d296e401 100644 --- a/src/xrt/drivers/hdk/hdk_device.cpp +++ b/src/xrt/drivers/hdk/hdk_device.cpp @@ -11,6 +11,7 @@ * * @author Ryan Pavlik * @author Kevin M. Godby + * @ingroup drv_hdk */ diff --git a/src/xrt/drivers/hdk/hdk_device.h b/src/xrt/drivers/hdk/hdk_device.h index cc12136a3..96dac3640 100644 --- a/src/xrt/drivers/hdk/hdk_device.h +++ b/src/xrt/drivers/hdk/hdk_device.h @@ -5,6 +5,7 @@ * @brief Interface to direct OSVR HDK driver code. * @author Jakob Bornecrantz * @author Ryan Pavlik + * @ingroup drv_hdk */ #pragma once diff --git a/src/xrt/drivers/hdk/hdk_interface.h b/src/xrt/drivers/hdk/hdk_interface.h index 0fb5a4aba..60835792c 100644 --- a/src/xrt/drivers/hdk/hdk_interface.h +++ b/src/xrt/drivers/hdk/hdk_interface.h @@ -5,6 +5,7 @@ * @brief Interface to direct OSVR HDK driver code. * @author Jakob Bornecrantz * @author Ryan Pavlik + * @ingroup drv_hdk */ #pragma once @@ -14,9 +15,27 @@ extern "C" { #endif +/*! + * @defgroup drv_hdk HDK Driver + * @ingroup drv + * + * @brief Driver for the HDK HMD. + */ + +/*! + * Probe for HDKs. + * + * @ingroup drv_hdk + */ struct xrt_prober* hdk_create_prober(); +/*! + * @dir drivers/hdk + * + * @brief @ref drv_hdk files. + */ + #ifdef __cplusplus } diff --git a/src/xrt/drivers/hdk/hdk_prober.c b/src/xrt/drivers/hdk/hdk_prober.c index c77c84585..68cf36308 100644 --- a/src/xrt/drivers/hdk/hdk_prober.c +++ b/src/xrt/drivers/hdk/hdk_prober.c @@ -5,6 +5,7 @@ * @brief OSVR HDK prober code. * @author Jakob Bornecrantz * @author Ryan Pavlik + * @ingroup drv_hdk */ #include diff --git a/src/xrt/drivers/ohmd/oh_device.c b/src/xrt/drivers/ohmd/oh_device.c index 5e7996c20..8a6df231f 100644 --- a/src/xrt/drivers/ohmd/oh_device.c +++ b/src/xrt/drivers/ohmd/oh_device.c @@ -4,6 +4,7 @@ * @file * @brief Adaptor to a OpenHMD device. * @author Jakob Bornecrantz + * @ingroup drv_ohmd */ diff --git a/src/xrt/drivers/ohmd/oh_device.h b/src/xrt/drivers/ohmd/oh_device.h index 2aeb92347..711ef9867 100644 --- a/src/xrt/drivers/ohmd/oh_device.h +++ b/src/xrt/drivers/ohmd/oh_device.h @@ -4,6 +4,7 @@ * @file * @brief Interface to OpenHMD driver code. * @author Jakob Bornecrantz + * @ingroup drv_ohmd */ #pragma once diff --git a/src/xrt/drivers/ohmd/oh_interface.h b/src/xrt/drivers/ohmd/oh_interface.h index 3b7f941e5..971087e22 100644 --- a/src/xrt/drivers/ohmd/oh_interface.h +++ b/src/xrt/drivers/ohmd/oh_interface.h @@ -4,6 +4,7 @@ * @file * @brief Interface to OpenHMD driver code. * @author Jakob Bornecrantz + * @ingroup drv_ohmd */ #pragma once @@ -12,10 +13,27 @@ extern "C" { #endif +/*! + * @defgroup drv_ohmd OpenHMD wrapper + * @ingroup drv + * + * @brief Wrapper driver around OpenHMD. + */ +/*! + * Create a proble for OpenHMD supported devices. + * + * @ingroup drv_ohmd + */ struct xrt_prober* oh_create_prober(); +/*! + * @dir drivers/ohmd + * + * @brief @ref drv_ohmd files. + */ + #ifdef __cplusplus } diff --git a/src/xrt/drivers/ohmd/oh_prober.c b/src/xrt/drivers/ohmd/oh_prober.c index 1a38e4ae5..de82a09b4 100644 --- a/src/xrt/drivers/ohmd/oh_prober.c +++ b/src/xrt/drivers/ohmd/oh_prober.c @@ -4,6 +4,7 @@ * @file * @brief OpenHMD prober code. * @author Jakob Bornecrantz + * @ingroup drv_ohmd */ #include diff --git a/src/xrt/include/xrt/xrt_documentation.h b/src/xrt/include/xrt/xrt_documentation.h index 29df81f69..c2546fba2 100644 --- a/src/xrt/include/xrt/xrt_documentation.h +++ b/src/xrt/include/xrt/xrt_documentation.h @@ -29,6 +29,13 @@ * @brief The main interface shared between the different components of Monado. */ +/*! + * @defgroup drv Drivers + * @ingroup xrt + * + * @brief Native and wrapper drivers in Monado. + */ + /*! * @dir include * @ingroup xrt @@ -56,3 +63,10 @@ * * @brief @ref oxr files. */ + +/*! + * @dir drivers + * @ingroup xrt + * + * @brief @ref drv files. + */