From 41dea932f866c10eb9c303298545d6b7151cfcd0 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sat, 27 Jul 2019 19:48:40 +0200 Subject: Clean up file documentation --- Doxyfile.in | 2 +- pugl/cairo_gl.h | 4 ++++ pugl/glew.h | 2 +- pugl/glu.h | 2 +- pugl/pugl.h | 2 +- pugl/pugl.hpp | 2 +- pugl/pugl_internal.h | 2 +- pugl/pugl_osx.m | 2 +- pugl/pugl_win.c | 2 +- pugl/pugl_win.h | 4 ++++ pugl/pugl_win_cairo.c | 2 +- pugl/pugl_win_gl.c | 4 ++++ pugl/pugl_x11.c | 2 +- pugl/pugl_x11.h | 4 ++++ pugl/pugl_x11_cairo.c | 4 ++++ pugl/pugl_x11_gl.c | 4 ++++ 16 files changed, 34 insertions(+), 10 deletions(-) diff --git a/Doxyfile.in b/Doxyfile.in index 7568692..b332116 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -663,7 +663,7 @@ SHOW_USED_FILES = YES # (if specified). # The default value is: YES. -SHOW_FILES = NO +SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the diff --git a/pugl/cairo_gl.h b/pugl/cairo_gl.h index 55e6150..b6e8566 100644 --- a/pugl/cairo_gl.h +++ b/pugl/cairo_gl.h @@ -14,6 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file cairo_gl.h Generic Cairo to OpenGL drawing support. +*/ + #include "pugl/gl.h" #include diff --git a/pugl/glew.h b/pugl/glew.h index 2dc9b05..f26ff93 100644 --- a/pugl/glew.h +++ b/pugl/glew.h @@ -15,7 +15,7 @@ */ /** - @file gl.h Portable header wrapper for glew.h. + @file glew.h Portable header wrapper for glew.h. Unfortunately, GL includes vary across platforms so this header allows for pure portable programs. diff --git a/pugl/glu.h b/pugl/glu.h index 78d181c..0ade70c 100644 --- a/pugl/glu.h +++ b/pugl/glu.h @@ -15,7 +15,7 @@ */ /** - @file gl.h Portable header wrapper for glu.h. + @file glu.h Portable header wrapper for glu.h. Unfortunately, GL includes vary across platforms so this header allows for pure portable programs. diff --git a/pugl/pugl.h b/pugl/pugl.h index 7e6036f..fab2b2b 100644 --- a/pugl/pugl.h +++ b/pugl/pugl.h @@ -15,7 +15,7 @@ */ /** - @file pugl.h API for Pugl, a minimal portable API for OpenGL. + @file pugl.h Public API. */ #ifndef PUGL_H_INCLUDED diff --git a/pugl/pugl.hpp b/pugl/pugl.hpp index d2702ab..ec96889 100644 --- a/pugl/pugl.hpp +++ b/pugl/pugl.hpp @@ -15,7 +15,7 @@ */ /** - @file pugl.hpp C++ API for Pugl, a minimal portable API for OpenGL. + @file pugl.hpp C++ wrapper for API. */ #ifndef PUGL_HPP_INCLUDED diff --git a/pugl/pugl_internal.h b/pugl/pugl_internal.h index 1f4cd4d..18d7a7a 100644 --- a/pugl/pugl_internal.h +++ b/pugl/pugl_internal.h @@ -15,7 +15,7 @@ */ /** - @file pugl_internal.h Private platform-independent definitions. + @file pugl_internal.h Platform-independent implementation. Note that this file contains function definitions, so it must be compiled into the final binary exactly once. Each platform specific implementation diff --git a/pugl/pugl_osx.m b/pugl/pugl_osx.m index 6ddb24d..a5ec994 100644 --- a/pugl/pugl_osx.m +++ b/pugl/pugl_osx.m @@ -16,7 +16,7 @@ */ /** - @file pugl_osx.m OSX/Cocoa Pugl Implementation. + @file pugl_osx.m MacOS implementation. */ #define GL_SILENCE_DEPRECATION 1 diff --git a/pugl/pugl_win.c b/pugl/pugl_win.c index b34ca43..2dd3fcc 100644 --- a/pugl/pugl_win.c +++ b/pugl/pugl_win.c @@ -15,7 +15,7 @@ */ /** - @file pugl_win.c Windows Pugl Implementation. + @file pugl_win.c Windows implementation. */ #include "pugl/pugl_internal.h" diff --git a/pugl/pugl_win.h b/pugl/pugl_win.h index e297c3a..c2dba2a 100644 --- a/pugl/pugl_win.h +++ b/pugl/pugl_win.h @@ -14,6 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file pugl_win.h Shared definitions for Windows implementation. +*/ + #include "pugl/pugl_internal_types.h" #include diff --git a/pugl/pugl_win_cairo.c b/pugl/pugl_win_cairo.c index 6dac736..0d2fb5f 100644 --- a/pugl/pugl_win_cairo.c +++ b/pugl/pugl_win_cairo.c @@ -15,7 +15,7 @@ */ /** - @file win_cairo.c Cairo graphics backend for Windows. + @file pugl_win_cairo.c Cairo graphics backend for Windows. */ #include "pugl/pugl_cairo_backend.h" diff --git a/pugl/pugl_win_gl.c b/pugl/pugl_win_gl.c index d86a78b..17528d5 100644 --- a/pugl/pugl_win_gl.c +++ b/pugl/pugl_win_gl.c @@ -14,6 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file pugl_win_gl.c OpenGL graphics backend for Windows. +*/ + #include "pugl/pugl_gl_backend.h" #include "pugl/pugl_internal_types.h" #include "pugl/pugl_win.h" diff --git a/pugl/pugl_x11.c b/pugl/pugl_x11.c index ad9acc8..5fcbd9f 100644 --- a/pugl/pugl_x11.c +++ b/pugl/pugl_x11.c @@ -17,7 +17,7 @@ */ /** - @file pugl_x11.c X11 Pugl Implementation. + @file pugl_x11.c X11 implementation. */ #define _POSIX_C_SOURCE 199309L diff --git a/pugl/pugl_x11.h b/pugl/pugl_x11.h index 6e528ca..e104a15 100644 --- a/pugl/pugl_x11.h +++ b/pugl/pugl_x11.h @@ -14,6 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file pugl_x11.h Shared definitions for X11 implementation. +*/ + #include "pugl/pugl.h" #include "pugl/pugl_internal_types.h" diff --git a/pugl/pugl_x11_cairo.c b/pugl/pugl_x11_cairo.c index 1a75b1c..bcec626 100644 --- a/pugl/pugl_x11_cairo.c +++ b/pugl/pugl_x11_cairo.c @@ -14,6 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file pugl_x11_cairo.c Cairo graphics backend for X11. +*/ + #include "pugl/pugl_cairo_backend.h" #include "pugl/pugl_internal_types.h" #include "pugl/pugl_x11.h" diff --git a/pugl/pugl_x11_gl.c b/pugl/pugl_x11_gl.c index 1277404..8ccc92d 100644 --- a/pugl/pugl_x11_gl.c +++ b/pugl/pugl_x11_gl.c @@ -14,6 +14,10 @@ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/** + @file pugl_x11_gl.c OpenGL graphics backend for X11. +*/ + #include "pugl/pugl_gl_backend.h" #include "pugl/pugl_internal_types.h" #include "pugl/pugl_x11.h" -- cgit v1.2.1