From 21b42c7b40c4dd0598b60fa7eda1e3c501e32e41 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Sat, 27 Sep 2014 03:13:27 +0000
Subject: Improve documentation.

---
 pugl/pugl.h | 36 +++++++++++++++++++++++++++++++++---
 1 file changed, 33 insertions(+), 3 deletions(-)

(limited to 'pugl/pugl.h')

diff --git a/pugl/pugl.h b/pugl/pugl.h
index d13ce12..68ecc19 100644
--- a/pugl/pugl.h
+++ b/pugl/pugl.h
@@ -134,6 +134,12 @@ typedef void (*PuglScrollFunc)(PuglView* view,
 */
 typedef void (*PuglSpecialFunc)(PuglView* view, bool press, PuglKey key);
 
+/**
+   @name Initialization
+   Configuration functions which must be called before creating a window.
+   @{
+*/
+
 /**
    Create a Pugl context.
 
@@ -170,6 +176,16 @@ puglInitResizable(PuglView* view, bool resizable);
 PUGL_API void
 puglInitContextType(PuglView* view, PuglContextType type);
 
+/**
+   @}
+*/
+
+/**
+   @name Windows
+   Window management functions.
+   @{
+*/
+
 /**
    Create a window with the settings given by the various puglInit functions.
 
@@ -190,6 +206,16 @@ puglShowWindow(PuglView* view);
 PUGL_API void
 puglHideWindow(PuglView* view);
 
+/**
+   Return the native window handle.
+*/
+PUGL_API PuglNativeWindow
+puglGetNativeWindow(PuglView* view);
+
+/**
+   @}
+*/
+
 /**
    Set the handle to be passed to all callbacks.
 
@@ -237,6 +263,12 @@ puglGetModifiers(PuglView* view);
 PUGL_API void
 puglIgnoreKeyRepeat(PuglView* view, bool ignore);
 
+/**
+   @name Event Callbacks
+   Functions to set event callbacks for handling user input.
+   @{
+*/
+
 /**
    Set the function to call when an event occurs.
 */
@@ -292,10 +324,8 @@ PUGL_API void
 puglSetReshapeFunc(PuglView* view, PuglReshapeFunc reshapeFunc);
 
 /**
-   Return the native window handle.
+   @}
 */
-PUGL_API PuglNativeWindow
-puglGetNativeWindow(PuglView* view);
 
 /**
    Grab the input focus.
-- 
cgit v1.2.3