aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-11-26 16:07:39 +0100
committerDavid Robillard <d@drobilla.net>2020-11-26 16:31:40 +0100
commit60d0de6069db3168e2cdb104e27d3cf6306e0263 (patch)
tree42fa6b456d53fc61a5947a5478901b9811ed7561 /include
parentc10c2a114cabcee614a5dd4a3c5359493f24d8e5 (diff)
downloadpugl-60d0de6069db3168e2cdb104e27d3cf6306e0263.tar.gz
pugl-60d0de6069db3168e2cdb104e27d3cf6306e0263.tar.bz2
pugl-60d0de6069db3168e2cdb104e27d3cf6306e0263.zip
Use named groups to group documentation
We'll need identifiers for these to refer to them in the Sphinx documentation.
Diffstat (limited to 'include')
-rw-r--r--include/pugl/pugl.h24
1 files changed, 11 insertions, 13 deletions
diff --git a/include/pugl/pugl.h b/include/pugl/pugl.h
index 150a5bc..9ddc1ec 100644
--- a/include/pugl/pugl.h
+++ b/include/pugl/pugl.h
@@ -84,7 +84,7 @@ typedef struct {
} PuglRect;
/**
- @name Events
+ @defgroup events Events
All updates to the view happen via events, which are dispatched to the
view's event function. Most events map directly to one from the underlying
@@ -568,7 +568,7 @@ typedef union {
/**
@}
- @name Status
+ @defgroup status Status
Most functions return a status code which can be used to check for errors.
@@ -598,7 +598,7 @@ puglStrerror(PuglStatus status);
/**
@}
- @name World
+ @defgroup world World
The top-level context of a Pugl application or plugin.
@@ -731,7 +731,7 @@ puglUpdate(PuglWorld* world, double timeout);
/**
@}
- @name View
+ @defgroup view View
A drawable region that receives events.
@@ -806,7 +806,7 @@ typedef enum {
typedef PuglStatus (*PuglEventFunc)(PuglView* view, const PuglEvent* event);
/**
- @name Setup
+ @defgroup setup Setup
Functions for creating and destroying a view.
@{
*/
@@ -889,8 +889,7 @@ puglGetViewHint(const PuglView* view, PuglViewHint hint);
/**
@}
- @anchor frame
- @name Frame
+ @defgroup frame Frame
Functions for working with the position and size of a view.
@{
*/
@@ -972,8 +971,8 @@ puglSetAspectRatio(PuglView* view, int minX, int minY, int maxX, int maxY);
/**
@}
- @name Windows
- Functions for working with system views and the window hierarchy.
+ @defgroup window Window
+ Functions to control the top-level window of a view.
@{
*/
@@ -1048,7 +1047,7 @@ puglGetNativeWindow(PuglView* view);
/**
@}
- @name Graphics
+ @defgroup graphics Graphics
Functions for working with the graphics context and scheduling redisplays.
@{
*/
@@ -1090,8 +1089,7 @@ puglPostRedisplayRect(PuglView* view, PuglRect rect);
/**
@}
- @anchor interaction
- @name Interaction
+ @defgroup interaction Interaction
Functions for interacting with the user and window system.
@{
*/
@@ -1246,7 +1244,7 @@ puglSendEvent(PuglView* view, const PuglEvent* event);
/**
@}
- @name Deprecated API
+ @defgroup deprecated Deprecated API
@{
*/