From 81fd21da1cd5aa2835f0193907342bb48d968164 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 26 Nov 2020 16:07:34 +0100 Subject: 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. --- bindings/cxx/include/pugl/cairo.hpp | 5 ----- bindings/cxx/include/pugl/gl.hpp | 5 ----- bindings/cxx/include/pugl/pugl.hpp | 5 ----- bindings/cxx/include/pugl/stub.hpp | 5 ----- bindings/cxx/include/pugl/vulkan.hpp | 14 ++++++-------- 5 files changed, 6 insertions(+), 28 deletions(-) (limited to 'bindings/cxx/include') diff --git a/bindings/cxx/include/pugl/cairo.hpp b/bindings/cxx/include/pugl/cairo.hpp index d321b0b..7416589 100644 --- a/bindings/cxx/include/pugl/cairo.hpp +++ b/bindings/cxx/include/pugl/cairo.hpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file cairo.hpp - @brief Declaration of Cairo backend accessor for C++. -*/ - #ifndef PUGL_CAIRO_HPP #define PUGL_CAIRO_HPP diff --git a/bindings/cxx/include/pugl/gl.hpp b/bindings/cxx/include/pugl/gl.hpp index 529babb..d8459a8 100644 --- a/bindings/cxx/include/pugl/gl.hpp +++ b/bindings/cxx/include/pugl/gl.hpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file gl.hpp - @brief OpenGL-specific C++ API. -*/ - #ifndef PUGL_GL_HPP #define PUGL_GL_HPP diff --git a/bindings/cxx/include/pugl/pugl.hpp b/bindings/cxx/include/pugl/pugl.hpp index 9e391fa..83aa4a0 100644 --- a/bindings/cxx/include/pugl/pugl.hpp +++ b/bindings/cxx/include/pugl/pugl.hpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file pugl.hpp - @brief Pugl C++ API wrapper. -*/ - #ifndef PUGL_PUGL_HPP #define PUGL_PUGL_HPP diff --git a/bindings/cxx/include/pugl/stub.hpp b/bindings/cxx/include/pugl/stub.hpp index 02a8dc2..8b37da4 100644 --- a/bindings/cxx/include/pugl/stub.hpp +++ b/bindings/cxx/include/pugl/stub.hpp @@ -14,11 +14,6 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file stub.hpp - @brief Declaration of Stub backend accessor for C++. -*/ - #ifndef PUGL_STUB_HPP #define PUGL_STUB_HPP diff --git a/bindings/cxx/include/pugl/vulkan.hpp b/bindings/cxx/include/pugl/vulkan.hpp index aaa221f..e50cbd6 100644 --- a/bindings/cxx/include/pugl/vulkan.hpp +++ b/bindings/cxx/include/pugl/vulkan.hpp @@ -14,12 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** - @file vulkan.hpp Vulkan-specific C++ 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_HPP @@ -39,10 +37,10 @@ namespace pugl { @defgroup vulkanxx Vulkan Vulkan graphics support. - Note that the Pugl C++ wrapper does not use vulkan.hpp because it is a + Note that the Pugl C++ wrapper does not use vulkan-hpp because it is a heavyweight dependency which not everyone uses, and its design is not very friendly to dynamic loading in plugins anyway. However, if you do use - vulkan.hpp smart handles, it is relatively straightforward to wrap the + vulkan-hpp smart handles, it is relatively straightforward to wrap the result of createSurface() manually. @ingroup pugl_cxx -- cgit v1.2.1