aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-02-29 19:58:19 +0100
committerDavid Robillard <d@drobilla.net>2020-03-01 20:32:23 +0100
commit1950f1e8dc21f5987d2e8a81a16e491933e99830 (patch)
tree716e301faaea6bb671b8e76954c5419861f506f5
parent40805c1ff90bf7c5917605cb71c701abc2d66313 (diff)
downloadpugl-1950f1e8dc21f5987d2e8a81a16e491933e99830.tar.gz
pugl-1950f1e8dc21f5987d2e8a81a16e491933e99830.tar.bz2
pugl-1950f1e8dc21f5987d2e8a81a16e491933e99830.zip
Fix documentation grouping
-rw-r--r--doc/mainpage.md2
-rw-r--r--pugl/pugl.hpp3
-rw-r--r--pugl/pugl_cairo.h11
-rw-r--r--pugl/pugl_gl.h11
-rw-r--r--pugl/pugl_stub.h27
5 files changed, 40 insertions, 14 deletions
diff --git a/doc/mainpage.md b/doc/mainpage.md
index b16551a..2e90050 100644
--- a/doc/mainpage.md
+++ b/doc/mainpage.md
@@ -1,6 +1,6 @@
This is the API documentation for Pugl.
The complete C API is documented in the [Pugl](@ref pugl) group,
-and the C++ wrapper in the [Puglmm](@ref puglmm) group.
+and the C++ wrapper in the [Puglxx](@ref puglxx) group.
The Pugl API revolves around two main objects:
the [World](@ref world) and the [View](@ref view).
diff --git a/pugl/pugl.hpp b/pugl/pugl.hpp
index e3f49ea..1c4b9e7 100644
--- a/pugl/pugl.hpp
+++ b/pugl/pugl.hpp
@@ -24,8 +24,9 @@
#include "pugl/pugl.h"
/**
- @defgroup puglmm Puglmm
+ @defgroup puglxx C++
Pugl C++ API wrapper.
+ @ingroup pugl
@{
*/
diff --git a/pugl/pugl_cairo.h b/pugl/pugl_cairo.h
index 001bca9..34c82c9 100644
--- a/pugl/pugl_cairo.h
+++ b/pugl/pugl_cairo.h
@@ -28,6 +28,13 @@ extern "C" {
#endif
/**
+ @defgroup cairo Cairo
+ Cairo graphics support.
+ @ingroup pugl
+ @{
+*/
+
+/**
Cairo graphics backend accessor.
Pass the return value to puglInitBackend() to draw to a view with Cairo.
@@ -35,6 +42,10 @@ extern "C" {
PUGL_API const PuglBackend*
puglCairoBackend(void);
+/**
+ @}
+*/
+
#ifdef __cplusplus
} /* extern "C" */
#endif
diff --git a/pugl/pugl_gl.h b/pugl/pugl_gl.h
index 7789116..a13cba2 100644
--- a/pugl/pugl_gl.h
+++ b/pugl/pugl_gl.h
@@ -28,6 +28,13 @@ extern "C" {
#endif
/**
+ @defgroup gl OpenGL
+ OpenGL graphics support.
+ @ingroup pugl
+ @{
+*/
+
+/**
OpenGL extension function.
*/
typedef void (*PuglGlFunc)(void);
@@ -50,4 +57,8 @@ puglGlBackend(void);
} /* extern "C" */
#endif
+/**
+ @}
+*/
+
#endif // PUGL_PUGL_GL_H
diff --git a/pugl/pugl_stub.h b/pugl/pugl_stub.h
index f50f96b..3ecc2b4 100644
--- a/pugl/pugl_stub.h
+++ b/pugl/pugl_stub.h
@@ -28,6 +28,21 @@ extern "C" {
#endif
/**
+ @defgroup stub Stub
+
+ Stub graphics backend.
+
+ The stub backend functions do nothing and always
+ return success. These do not make for a usable backend on their own since
+ the platform implementation would fail to create a window, but are useful
+ for other backends to reuse since not all need non-trivial implementations
+ of every backend function.
+
+ @ingroup pugl
+ @{
+*/
+
+/**
Stub graphics backend.
This backend just creates a simple native window without setting up any
@@ -37,18 +52,6 @@ PUGL_API
const PuglBackend*
puglStubBackend(void);
-/**
- @name Stub backend functions
-
- Implementations of stub backend functions which do nothing and always return
- success. These do not make for a usable backend on their own since the
- platform implementation would fail to create a window, but are useful for
- other backends to reuse since not all need non-trivial implementations of
- every backend function.
-
- @{
-*/
-
static inline PuglStatus
puglStubConfigure(PuglView* view)
{