diff options
| author | David Robillard <d@drobilla.net> | 2020-11-26 16:07:34 +0100 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2020-11-26 16:31:35 +0100 |
| commit | 81fd21da1cd5aa2835f0193907342bb48d968164 (patch) | |
| tree | f3d053c3e5b3135fa1b9a47106ffa5b23f840a19 /include/pugl | |
| parent | 9de33a8805490274dc03d84a6483bc430bb345ed (diff) | |
| download | pugl-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 'include/pugl')
| -rw-r--r-- | include/pugl/cairo.h | 5 | ||||
| -rw-r--r-- | include/pugl/gl.h | 5 | ||||
| -rw-r--r-- | include/pugl/pugl.h | 11 | ||||
| -rw-r--r-- | include/pugl/stub.h | 5 | ||||
| -rw-r--r-- | include/pugl/vulkan.h | 10 |
5 files changed, 7 insertions, 29 deletions
diff --git a/include/pugl/cairo.h b/include/pugl/cairo.h index da9f724..d72580d 100644 --- a/include/pugl/cairo.h +++ b/include/pugl/cairo.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file cairo.h - @brief Declaration of Cairo backend accessor. -*/ - #ifndef PUGL_CAIRO_H #define PUGL_CAIRO_H diff --git a/include/pugl/gl.h b/include/pugl/gl.h index 79cb6e9..eb86c3d 100644 --- a/include/pugl/gl.h +++ b/include/pugl/gl.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file gl.h - @brief OpenGL-specific API. -*/ - #ifndef PUGL_GL_H #define PUGL_GL_H diff --git a/include/pugl/pugl.h b/include/pugl/pugl.h index d04c76f..a8f6d82 100644 --- a/include/pugl/pugl.h +++ b/include/pugl/pugl.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl.h - @brief Pugl API. -*/ - #ifndef PUGL_PUGL_H #define PUGL_PUGL_H @@ -862,9 +857,9 @@ puglGetHandle(PuglView* view); Pugl includes the following backends: - - puglCairoBackend(), declared in pugl/cairo.h - - puglGlBackend(), declared in pugl/gl.h - - puglVulkanBackend(), declared in pugl/vulkan.h + - puglCairoBackend() + - puglGlBackend() + - puglVulkanBackend() Note that backends are modular and not compiled into the main Pugl library to avoid unnecessary dependencies. To use a particular backend, diff --git a/include/pugl/stub.h b/include/pugl/stub.h index 61791fd..d2d1236 100644 --- a/include/pugl/stub.h +++ b/include/pugl/stub.h @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file stub.h - @brief Stub backend functions and accessor declaration. -*/ - #ifndef PUGL_STUB_H #define PUGL_STUB_H diff --git a/include/pugl/vulkan.h b/include/pugl/vulkan.h index 05e13e2..bd4ad8e 100644 --- a/include/pugl/vulkan.h +++ b/include/pugl/vulkan.h @@ -14,12 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file vulkan.h Vulkan-specific API. - - Note that this header includes Vulkan headers, so if you are writing a - program or plugin that dynamically loads vulkan, you should first define - `VK_NO_PROTOTYPES` before including it. +/* + Note that this header includes Vulkan headers, so if you are writing a + program or plugin that dynamically loads vulkan, you should first define + `VK_NO_PROTOTYPES` before including it. */ #ifndef PUGL_VULKAN_H |