aboutsummaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-11-26 16:07:34 +0100
committerDavid Robillard <d@drobilla.net>2020-11-26 16:31:35 +0100
commit81fd21da1cd5aa2835f0193907342bb48d968164 (patch)
treef3d053c3e5b3135fa1b9a47106ffa5b23f840a19 /examples
parent9de33a8805490274dc03d84a6483bc430bb345ed (diff)
downloadpugl-81fd21da1cd5aa2835f0193907342bb48d968164.tar.gz
pugl-81fd21da1cd5aa2835f0193907342bb48d968164.tar.bz2
pugl-81fd21da1cd5aa2835f0193907342bb48d968164.zip
Remove file documentation
These will not be used in the Sphinx documentation, and most were self-explanatory and only there to make the Doxygen index look nice anyway. Where there was actually useful information, it has been preserved as regular comments.
Diffstat (limited to 'examples')
-rw-r--r--examples/pugl_cairo_demo.c5
-rw-r--r--examples/pugl_cursor_demo.c5
-rw-r--r--examples/pugl_cxx_demo.cpp5
-rw-r--r--examples/pugl_embed_demo.c5
-rw-r--r--examples/pugl_print_events.c5
-rw-r--r--examples/pugl_shader_demo.c37
-rw-r--r--examples/pugl_vulkan_cxx_demo.cpp23
-rw-r--r--examples/pugl_vulkan_demo.c8
-rw-r--r--examples/pugl_window_demo.c5
-rw-r--r--examples/rects.h8
10 files changed, 36 insertions, 70 deletions
diff --git a/examples/pugl_cairo_demo.c b/examples/pugl_cairo_demo.c
index c143c3c..48a02db 100644
--- a/examples/pugl_cairo_demo.c
+++ b/examples/pugl_cairo_demo.c
@@ -14,11 +14,6 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file pugl_cairo_demo.c
- @brief An example of drawing with Cairo.
-*/
-
#include "demo_utils.h"
#include "test/test_utils.h"
diff --git a/examples/pugl_cursor_demo.c b/examples/pugl_cursor_demo.c
index 916460a..f20b0ea 100644
--- a/examples/pugl_cursor_demo.c
+++ b/examples/pugl_cursor_demo.c
@@ -14,11 +14,6 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file pugl_cursor_demo.c
- @brief An example of changing the mouse cursor.
-*/
-
#include "test/test_utils.h"
#include "pugl/gl.h"
diff --git a/examples/pugl_cxx_demo.cpp b/examples/pugl_cxx_demo.cpp
index 0aa66ad..8269ae4 100644
--- a/examples/pugl_cxx_demo.cpp
+++ b/examples/pugl_cxx_demo.cpp
@@ -14,11 +14,6 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file pugl_cxx_demo.cpp
- @brief A simple demo of the Pugl C++ API.
-*/
-
#include "cube_view.h"
#include "demo_utils.h"
#include "test/test_utils.h"
diff --git a/examples/pugl_embed_demo.c b/examples/pugl_embed_demo.c
index 5acef73..55480f6 100644
--- a/examples/pugl_embed_demo.c
+++ b/examples/pugl_embed_demo.c
@@ -14,11 +14,6 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file pugl_embed_demo.c
- @brief An example of embedding a view in another.
-*/
-
#include "cube_view.h"
#include "demo_utils.h"
#include "test/test_utils.h"
diff --git a/examples/pugl_print_events.c b/examples/pugl_print_events.c
index 3f6bb06..8f8874b 100644
--- a/examples/pugl_print_events.c
+++ b/examples/pugl_print_events.c
@@ -14,11 +14,6 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file pugl_print_events.c
- @brief A utility program that prints view events.
-*/
-
#include "test/test_utils.h"
#include "pugl/pugl.h"
diff --git a/examples/pugl_shader_demo.c b/examples/pugl_shader_demo.c
index 3f5e7f3..800b8f0 100644
--- a/examples/pugl_shader_demo.c
+++ b/examples/pugl_shader_demo.c
@@ -14,25 +14,24 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @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
- typical 2D graphics API.
-
- The program draws a bunch of rectangles with borders, using instancing.
- Each rectangle has origin, size, and fill color attributes, which are shared
- for all four vertices. On each frame, a single buffer with all the
- rectangle data is sent to the GPU, and everything is drawn with a single
- draw call.
-
- This is not particularly realistic or optimal, but serves as a decent rough
- benchmark for how much simple geometry you can draw. The number of
- rectangles can be given on the command line. For reference, it begins to
- struggle to maintain 60 FPS on my machine (1950x + Vega64) with more than
- about 100000 rectangles.
+/*
+ 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
+ typical 2D graphics API.
+
+ The program draws a bunch of rectangles with borders, using instancing.
+ Each rectangle has origin, size, and fill color attributes, which are shared
+ for all four vertices. On each frame, a single buffer with all the
+ rectangle data is sent to the GPU, and everything is drawn with a single
+ draw call.
+
+ This is not particularly realistic or optimal, but serves as a decent rough
+ benchmark for how much simple geometry you can draw. The number of
+ rectangles can be given on the command line. For reference, it begins to
+ struggle to maintain 60 FPS on my machine (1950x + Vega64) with more than
+ about 100000 rectangles.
*/
#include "demo_utils.h"
diff --git a/examples/pugl_vulkan_cxx_demo.cpp b/examples/pugl_vulkan_cxx_demo.cpp
index 677750f..632f784 100644
--- a/examples/pugl_vulkan_cxx_demo.cpp
+++ b/examples/pugl_vulkan_cxx_demo.cpp
@@ -14,18 +14,17 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file pugl_vulkan_cxx_demo.cpp
- @brief An example of drawing with Vulkan.
-
- This is an example of using Vulkan for pixel-perfect 2D drawing. It uses
- the same data and shaders as pugl_shader_demo.c and attempts to draw the
- same thing, except using Vulkan.
-
- Since Vulkan is a complicated and very verbose API, this example is
- unfortunately much larger than the others. You should not use this as a
- resource to learn Vulkan, but it provides a decent demo of using Vulkan with
- Pugl that works nicely on all supported platforms.
+/*
+ An example of drawing with Vulkan.
+
+ This is an example of using Vulkan for pixel-perfect 2D drawing. It uses
+ the same data and shaders as pugl_shader_demo.c and attempts to draw the
+ same thing, except using Vulkan.
+
+ Since Vulkan is a complicated and very verbose API, this example is
+ unfortunately much larger than the others. You should not use this as a
+ resource to learn Vulkan, but it provides a decent demo of using Vulkan with
+ Pugl that works nicely on all supported platforms.
*/
#include "demo_utils.h"
diff --git a/examples/pugl_vulkan_demo.c b/examples/pugl_vulkan_demo.c
index c609d10..ec96ec3 100644
--- a/examples/pugl_vulkan_demo.c
+++ b/examples/pugl_vulkan_demo.c
@@ -15,9 +15,11 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file pugl_vulkan_demo.c
- @brief A simple example of drawing with Vulkan.
+/*
+ A simple example of drawing with Vulkan.
+
+ For a more advanced demo that actually draws something interesting, see
+ pugl_vulkan_cxx_demo.cpp.
*/
#include "demo_utils.h"
diff --git a/examples/pugl_window_demo.c b/examples/pugl_window_demo.c
index 080d23b..3dfc39a 100644
--- a/examples/pugl_window_demo.c
+++ b/examples/pugl_window_demo.c
@@ -14,9 +14,8 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file pugl_window_demo.c
- @brief A demonstration of multiple Pugl windows.
+/*
+ A demonstration of using multiple top-level windows.
*/
#include "cube_view.h"
diff --git a/examples/rects.h b/examples/rects.h
index f53698c..3537a5b 100644
--- a/examples/rects.h
+++ b/examples/rects.h
@@ -14,14 +14,6 @@
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- @file rects.h
- @brief Utilities for rectangle animation demos.
-
- This file contains common definitions for demos that show an animation of
- many 2D rectangles.
-*/
-
#ifndef EXAMPLES_RECTS_H
#define EXAMPLES_RECTS_H