mirror of
https://gitlab.freedesktop.org/monado/monado.git
synced 2024-12-29 11:06:18 +00:00
d/*: Add a bit of documentation organization
This commit is contained in:
parent
a6ea2816cb
commit
ab6defc610
|
@ -11,6 +11,7 @@
|
||||||
*
|
*
|
||||||
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
|
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
|
||||||
* @author Kevin M. Godby <kevin@godby.org>
|
* @author Kevin M. Godby <kevin@godby.org>
|
||||||
|
* @ingroup drv_hdk
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -5,6 +5,7 @@
|
||||||
* @brief Interface to direct OSVR HDK driver code.
|
* @brief Interface to direct OSVR HDK driver code.
|
||||||
* @author Jakob Bornecrantz <jakob@collabora.com>
|
* @author Jakob Bornecrantz <jakob@collabora.com>
|
||||||
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
|
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
|
||||||
|
* @ingroup drv_hdk
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
|
@ -5,6 +5,7 @@
|
||||||
* @brief Interface to direct OSVR HDK driver code.
|
* @brief Interface to direct OSVR HDK driver code.
|
||||||
* @author Jakob Bornecrantz <jakob@collabora.com>
|
* @author Jakob Bornecrantz <jakob@collabora.com>
|
||||||
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
|
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
|
||||||
|
* @ingroup drv_hdk
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
@ -14,9 +15,27 @@ extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @defgroup drv_hdk HDK Driver
|
||||||
|
* @ingroup drv
|
||||||
|
*
|
||||||
|
* @brief Driver for the HDK HMD.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* Probe for HDKs.
|
||||||
|
*
|
||||||
|
* @ingroup drv_hdk
|
||||||
|
*/
|
||||||
struct xrt_prober*
|
struct xrt_prober*
|
||||||
hdk_create_prober();
|
hdk_create_prober();
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @dir drivers/hdk
|
||||||
|
*
|
||||||
|
* @brief @ref drv_hdk files.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
|
|
@ -5,6 +5,7 @@
|
||||||
* @brief OSVR HDK prober code.
|
* @brief OSVR HDK prober code.
|
||||||
* @author Jakob Bornecrantz <jakob@collabora.com>
|
* @author Jakob Bornecrantz <jakob@collabora.com>
|
||||||
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
|
* @author Ryan Pavlik <ryan.pavlik@collabora.com>
|
||||||
|
* @ingroup drv_hdk
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
|
|
|
@ -4,6 +4,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Adaptor to a OpenHMD device.
|
* @brief Adaptor to a OpenHMD device.
|
||||||
* @author Jakob Bornecrantz <jakob@collabora.com>
|
* @author Jakob Bornecrantz <jakob@collabora.com>
|
||||||
|
* @ingroup drv_ohmd
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -4,6 +4,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Interface to OpenHMD driver code.
|
* @brief Interface to OpenHMD driver code.
|
||||||
* @author Jakob Bornecrantz <jakob@collabora.com>
|
* @author Jakob Bornecrantz <jakob@collabora.com>
|
||||||
|
* @ingroup drv_ohmd
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
|
@ -4,6 +4,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief Interface to OpenHMD driver code.
|
* @brief Interface to OpenHMD driver code.
|
||||||
* @author Jakob Bornecrantz <jakob@collabora.com>
|
* @author Jakob Bornecrantz <jakob@collabora.com>
|
||||||
|
* @ingroup drv_ohmd
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#pragma once
|
#pragma once
|
||||||
|
@ -12,10 +13,27 @@
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#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*
|
struct xrt_prober*
|
||||||
oh_create_prober();
|
oh_create_prober();
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @dir drivers/ohmd
|
||||||
|
*
|
||||||
|
* @brief @ref drv_ohmd files.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,6 +4,7 @@
|
||||||
* @file
|
* @file
|
||||||
* @brief OpenHMD prober code.
|
* @brief OpenHMD prober code.
|
||||||
* @author Jakob Bornecrantz <jakob@collabora.com>
|
* @author Jakob Bornecrantz <jakob@collabora.com>
|
||||||
|
* @ingroup drv_ohmd
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <stdio.h>
|
#include <stdio.h>
|
||||||
|
|
|
@ -29,6 +29,13 @@
|
||||||
* @brief The main interface shared between the different components of Monado.
|
* @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
|
* @dir include
|
||||||
* @ingroup xrt
|
* @ingroup xrt
|
||||||
|
@ -56,3 +63,10 @@
|
||||||
*
|
*
|
||||||
* @brief @ref oxr files.
|
* @brief @ref oxr files.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/*!
|
||||||
|
* @dir drivers
|
||||||
|
* @ingroup xrt
|
||||||
|
*
|
||||||
|
* @brief @ref drv files.
|
||||||
|
*/
|
||||||
|
|
Loading…
Reference in a new issue