monado/src/xrt/compositor/main/comp_documentation.h
2019-04-06 13:05:35 +01:00

62 lines
1.1 KiB
C

// Copyright 2019, Collabora, Ltd.
// SPDX-License-Identifier: BSL-1.0
/*!
* @file
* @brief Main compositor written using Vulkan header.
* @author Jakob Bornecrantz <jakob@collabora.com>
* @author Lubosz Sarnecki <lubosz.sarnecki@collabora.com>
* @ingroup comp
*/
#pragma once
/*!
* @defgroup comp Compositor
* @ingroup xrt
*
* @brief Main compositing code.
*/
/*!
* @defgroup comp_client Compositor client glue code
* @ingroup comp
*
* @brief Glue code between client program to the main compositor.
*/
/*!
* @defgroup comp_common Common compositor code
* @ingroup comp
*
* @brief Common compositor code shared between main and client code.
*/
/*!
* @dir compositor
* @ingroup xrt
*
* @brief Shared code and helpers for Monado.
*/
/*!
* @dir compositor/client
* @ingroup comp
*
* @brief Smaller pieces of auxiliary utilities code.
*/
/*!
* @dir compositor/common
* @ingroup comp
*
* @brief Common compositor code shared between main and client code.
*/
/*!
* @dir compositor/main
* @ingroup comp
*
* @brief Main chunk of compositor code.
*/