Commit ab6defc6 authored by Jakob Bornecrantz's avatar Jakob Bornecrantz

d/*: Add a bit of documentation organization

parent a6ea2816
Pipeline #30325 passed with stages
in 41 seconds
......@@ -11,6 +11,7 @@
*
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
* @author Kevin M. Godby <kevin@godby.org>
* @ingroup drv_hdk
*/
......
......@@ -5,6 +5,7 @@
* @brief Interface to direct OSVR HDK driver code.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
* @ingroup drv_hdk
*/
#pragma once
......
......@@ -5,6 +5,7 @@
* @brief Interface to direct OSVR HDK driver code.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
* @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
}
......
......@@ -5,6 +5,7 @@
* @brief OSVR HDK prober code.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
* @ingroup drv_hdk
*/
#include <stdio.h>
......
......@@ -4,6 +4,7 @@
* @file
* @brief Adaptor to a OpenHMD device.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @ingroup drv_ohmd
*/
......
......@@ -4,6 +4,7 @@
* @file
* @brief Interface to OpenHMD driver code.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @ingroup drv_ohmd
*/
#pragma once
......
......@@ -4,6 +4,7 @@
* @file
* @brief Interface to OpenHMD driver code.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @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
}
......
......@@ -4,6 +4,7 @@
* @file
* @brief OpenHMD prober code.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @ingroup drv_ohmd
*/
#include <stdio.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.
*/
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment