Simplify documentation structure

5 files changed, 22 insertions, 44 deletions

diff --git a/include/pugl/pugl.h b/include/pugl/pugl.h
index bad881f..13c0b22 100644
--- a/include/pugl/pugl.h
+++ b/include/pugl/pugl.h
@@ -93,14 +93,12 @@ typedef struct {
 } PuglRect;
 
 /**
-   @defgroup events Events
-
-   Event definitions.
+   @name Events
 
    All updates to the view happen via events, which are dispatched to the
-   view's event function by Pugl.  Most events map directly to one from the
-   underlying window system, but some are constructed by Pugl itself so there
-   is not necessarily a direct correspondence.
+   view's event function.  Most events map directly to one from the underlying
+   window system, but some are constructed by Pugl itself so there is not
+   necessarily a direct correspondence.
 
    @{
 */
@@ -559,9 +557,9 @@ typedef union {
 
 /**
    @}
-   @defgroup status Status
+   @name Status
 
-   Status codes and error handling.
+   Most functions return a status code which can be used to check for errors.
 
    @{
 */
@@ -593,7 +591,7 @@ puglStrerror(PuglStatus status);
 
 /**
    @}
-   @defgroup world World
+   @name World
 
    The top-level context of a Pugl application or plugin.
 
@@ -777,8 +775,7 @@ puglUpdate(PuglWorld* world, double timeout);
 
 /**
    @}
-
-   @defgroup view View
+   @name View
 
    A drawable region that receives events.
 
diff --git a/include/pugl/pugl.hpp b/include/pugl/pugl.hpp
index 8fc479f..d9e725a 100644
--- a/include/pugl/pugl.hpp
+++ b/include/pugl/pugl.hpp
@@ -32,6 +32,11 @@
 #include <type_traits>
 
 /**
+   Pugl C++ API namespace.
+*/
+namespace pugl {
+
+/**
    @defgroup pugl_cxx C++ API
    C++ API wrapper.
 
@@ -39,11 +44,6 @@
    @{
 */
 
-/**
-   Pugl C++ API namespace.
-*/
-namespace pugl {
-
 namespace detail {
 
 /// Free function for a C object
@@ -84,9 +84,7 @@ private:
 using Rect = PuglRect; ///< @copydoc PuglRect
 
 /**
-   @defgroup eventsxx Events
-   @ingroup pugl_cxx
-   @copydoc events
+   @name Events
    @{
 */
 
@@ -180,9 +178,7 @@ using TimerEvent = Event<PUGL_TIMER, PuglEventTimer>;
 
 /**
    @}
-   @defgroup statusxx Status
-   @ingroup pugl_cxx
-   @copydoc status
+   @name Status
    @{
 */
 
@@ -213,9 +209,7 @@ strerror(const pugl::Status status)
 
 /**
    @}
-   @defgroup worldxx World
-   @ingroup pugl_cxx
-   @copydoc world
+   @name World
    @{
 */
 
@@ -350,9 +344,7 @@ Clock::now() const
 
 /**
    @}
-   @defgroup viewxx View
-   @ingroup pugl_cxx
-   @copydoc view
+   @name View
    @{
 */
 
@@ -715,12 +707,9 @@ private:
 
 /**
    @}
+   @}
 */
 
 } // namespace pugl
 
-/**
-   @}
-*/
-
 #endif // PUGL_PUGL_HPP
diff --git a/include/pugl/pugl_cairo.h b/include/pugl/pugl_cairo.h
index 0e0698b..6e5a035 100644
--- a/include/pugl/pugl_cairo.h
+++ b/include/pugl/pugl_cairo.h
@@ -36,7 +36,7 @@ PUGL_BEGIN_DECLS
 /**
    Cairo graphics backend accessor.
 
-   Pass the return value to puglSetBackend() to draw to a view with Cairo.
+   Pass the returned value to puglSetBackend() to draw to a view with Cairo.
 */
 PUGL_API PUGL_CONST_FUNC const PuglBackend*
 puglCairoBackend(void);
diff --git a/include/pugl/pugl_gl.h b/include/pugl/pugl_gl.h
index 471c5ac..b0100ce 100644
--- a/include/pugl/pugl_gl.h
+++ b/include/pugl/pugl_gl.h
@@ -47,7 +47,7 @@ puglGetProcAddress(const char* name);
 /**
    OpenGL graphics backend.
 
-   Pass the return value to puglSetBackend() to draw to a view with OpenGL.
+   Pass the returned value to puglSetBackend() to draw to a view with OpenGL.
 */
 PUGL_API PUGL_CONST_FUNC const PuglBackend*
 puglGlBackend(void);
diff --git a/include/pugl/pugl_stub.h b/include/pugl/pugl_stub.h
index f50418e..569415c 100644
--- a/include/pugl/pugl_stub.h
+++ b/include/pugl/pugl_stub.h
@@ -28,21 +28,13 @@ PUGL_BEGIN_DECLS
 
 /**
    @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.
-
+   Native graphics support.
    @ingroup pugl_c
    @{
 */
 
 /**
-   Stub graphics backend.
+   Stub graphics backend accessor.
 
    This backend just creates a simple native window without setting up any
    portable graphics API.