From 85104b239735498f4b9c58fb87f93dd78631292f Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sat, 16 May 2020 21:17:58 +0200 Subject: Fix file documentation --- examples/pugl_cairo_demo.c | 3 ++- examples/pugl_cxx_demo.cpp | 3 ++- examples/pugl_embed_demo.c | 3 ++- examples/pugl_print_events.c | 3 ++- examples/pugl_shader_demo.c | 3 ++- examples/pugl_window_demo.c | 3 ++- examples/rects.h | 3 ++- 7 files changed, 14 insertions(+), 7 deletions(-) (limited to 'examples') diff --git a/examples/pugl_cairo_demo.c b/examples/pugl_cairo_demo.c index 483446f..5f8dad9 100644 --- a/examples/pugl_cairo_demo.c +++ b/examples/pugl_cairo_demo.c @@ -15,7 +15,8 @@ */ /** - @file pugl_cairo_demo.c An example of drawing with Cairo. + @file pugl_cairo_demo.c + @brief An example of drawing with Cairo. */ #include "demo_utils.h" diff --git a/examples/pugl_cxx_demo.cpp b/examples/pugl_cxx_demo.cpp index 6a7538f..2fa7d8b 100644 --- a/examples/pugl_cxx_demo.cpp +++ b/examples/pugl_cxx_demo.cpp @@ -15,7 +15,8 @@ */ /** - @file pugl_cxx_demo.cpp A simple demo of the Pugl C++ API. + @file pugl_cxx_demo.cpp + @brief A simple demo of the Pugl C++ API. */ #include "cube_view.h" diff --git a/examples/pugl_embed_demo.c b/examples/pugl_embed_demo.c index 3a7b051..40c8e54 100644 --- a/examples/pugl_embed_demo.c +++ b/examples/pugl_embed_demo.c @@ -15,7 +15,8 @@ */ /** - @file pugl_embed_demo.c An example of embedding a view in another. + @file pugl_embed_demo.c + @brief An example of embedding a view in another. */ #include "cube_view.h" diff --git a/examples/pugl_print_events.c b/examples/pugl_print_events.c index 52b58c4..e2661e0 100644 --- a/examples/pugl_print_events.c +++ b/examples/pugl_print_events.c @@ -15,7 +15,8 @@ */ /** - @file pugl_print_events.c A utility program that prints view events. + @file pugl_print_events.c + @brief A utility program that prints view events. */ #include "test/test_utils.h" diff --git a/examples/pugl_shader_demo.c b/examples/pugl_shader_demo.c index ac5fe84..ecad8ae 100644 --- a/examples/pugl_shader_demo.c +++ b/examples/pugl_shader_demo.c @@ -15,7 +15,8 @@ */ /** - @file pugl_shader_demo.c An example of drawing with OpenGL 3/4. + @file pugl_shader_demo.c + @brief An example of drawing with OpenGL 3/4. This is an example of using OpenGL for pixel-perfect 2D drawing. It uses pixel coordinates for positions and sizes so that things work roughly like a diff --git a/examples/pugl_window_demo.c b/examples/pugl_window_demo.c index 3a0dc51..4d5c4ad 100644 --- a/examples/pugl_window_demo.c +++ b/examples/pugl_window_demo.c @@ -15,7 +15,8 @@ */ /** - @file pugl_window_demo.c A demonstration of multiple Pugl windows. + @file pugl_window_demo.c + @brief A demonstration of multiple Pugl windows. */ #include "cube_view.h" diff --git a/examples/rects.h b/examples/rects.h index aca0256..ed518f4 100644 --- a/examples/rects.h +++ b/examples/rects.h @@ -15,7 +15,8 @@ */ /** - @file rects.h Utilities for rectangle animation demos. + @file rects.h + @brief Utilities for rectangle animation demos. This file contains common definitions for demos that show an animation of many 2D rectangles. -- cgit v1.2.1