comp: Refactor documentation

src/xrt/compositor/CMakeLists.txt

@@ -26,6 +26,7 @@ set(GL_SOURCE_FILES
 	main/comp_compositor.h
 	main/comp_distortion.c
 	main/comp_distortion.h
+	main/comp_documentation.h
 	main/comp_glue_gl.c
 	main/comp_glue_vk.c
 	main/comp_glue_xlib.c

src/xrt/compositor/main/comp_compositor.h

@@ -21,34 +21,6 @@ extern "C" {
 #endif
 
 
-/*
- *
- * Documentation
- *
- */
-
-/*!
- * @defgroup comp Compositor
- * Main compositing code.
- *
- * @ingroup xrt
- */
-
-/*!
- * Glue code between client program to the main compositor.
- *
- * @defgroup comp_client Compositor client glue code
- * @ingroup comp
- */
-
-/*!
- * Common compositor code shared between main and client code.
- *
- * @defgroup comp_common Common compositor code
- * @ingroup comp
- */
-
-
 /*
  *
  * Structs

src/xrt/compositor/main/comp_documentation.h

@@ -0,0 +1,61 @@
+// 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.
+ */