From 70a01e11a5c7b6c47717eb4b324e30ee331a817a Mon Sep 17 00:00:00 2001 From: David Robillard Date: Fri, 12 May 2023 17:09:03 -0400 Subject: Improve size hint documentation --- include/pugl/pugl.h | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) (limited to 'include') diff --git a/include/pugl/pugl.h b/include/pugl/pugl.h index 189cfe4..f9dd37e 100644 --- a/include/pugl/pugl.h +++ b/include/pugl/pugl.h @@ -955,9 +955,27 @@ typedef enum { size gracefully. */ typedef enum { - PUGL_DEFAULT_SIZE, ///< Default size - PUGL_MIN_SIZE, ///< Minimum size - PUGL_MAX_SIZE, ///< Maximum size + /** + Default size. + + This is used as the size during window creation as a default, if no other + size is specified. + */ + PUGL_DEFAULT_SIZE, + + /** + Minimum size. + + If set, the view's size should be constrained to be at least this large. + */ + PUGL_MIN_SIZE, + + /** + Maximum size. + + If set, the view's size should be constrained to be at most this large. + */ + PUGL_MAX_SIZE, /** Fixed aspect ratio. -- cgit v1.2.1