aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2020-10-29 17:54:55 +0100
committerDavid Robillard <d@drobilla.net>2020-10-30 10:58:31 +0100
commitcaf17373026a9de07ccd72edc282d46486257fb5 (patch)
tree99d68a4dbc4f3d08a075e6e3653ccde5aa6b0712
parentd7703c822c7b2373615a972f02667287635c667b (diff)
downloadpugl-caf17373026a9de07ccd72edc282d46486257fb5.tar.gz
pugl-caf17373026a9de07ccd72edc282d46486257fb5.tar.bz2
pugl-caf17373026a9de07ccd72edc282d46486257fb5.zip
Clean up installed man pages
-rw-r--r--bindings/cxx/include/pugl/pugl.hpp7
-rw-r--r--doc/mainpage.md4
-rw-r--r--doc/reference.doxygen.in2
-rw-r--r--include/pugl/cairo.h2
-rw-r--r--include/pugl/gl.h2
-rw-r--r--include/pugl/pugl.h6
-rw-r--r--include/pugl/stub.h2
-rw-r--r--include/pugl/vulkan.h2
m---------waflib0
-rw-r--r--wscript5
10 files changed, 16 insertions, 16 deletions
diff --git a/bindings/cxx/include/pugl/pugl.hpp b/bindings/cxx/include/pugl/pugl.hpp
index 65793b2..32680cd 100644
--- a/bindings/cxx/include/pugl/pugl.hpp
+++ b/bindings/cxx/include/pugl/pugl.hpp
@@ -32,16 +32,13 @@
#include <stdexcept>
#include <type_traits>
-/**
- Pugl C++ API namespace.
-*/
namespace pugl {
/**
- @defgroup pugl_cxx C++ API
+ @defgroup puglxx Pugl C++ API
C++ API wrapper.
- @ingroup pugl
+ @ingroup pugldoc
@{
*/
diff --git a/doc/mainpage.md b/doc/mainpage.md
index 3204a36..84f4722 100644
--- a/doc/mainpage.md
+++ b/doc/mainpage.md
@@ -4,8 +4,8 @@ This is the documentation for Pugl, a minimal API for writing GUIs.
Pugl is implemented in C, but also provides a header-only C++ API wrapper.
- * [C API reference](@ref pugl_c)
- * [C++ API reference](@ref pugl_cxx)
+ * [C API reference](@ref pugl)
+ * [C++ API reference](@ref puglxx)
## Overview
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in
index 5fecdbe..b3d5acd 100644
--- a/doc/reference.doxygen.in
+++ b/doc/reference.doxygen.in
@@ -670,7 +670,7 @@ SHOW_FILES = YES
# Folder Tree View (if specified).
# The default value is: YES.
-SHOW_NAMESPACES = YES
+SHOW_NAMESPACES = NO
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
# doxygen should invoke to get the current version for each file (typically from
diff --git a/include/pugl/cairo.h b/include/pugl/cairo.h
index 2022c21..da9f724 100644
--- a/include/pugl/cairo.h
+++ b/include/pugl/cairo.h
@@ -29,7 +29,7 @@ PUGL_BEGIN_DECLS
/**
@defgroup cairo Cairo
Cairo graphics support.
- @ingroup pugl_c
+ @ingroup pugl
@{
*/
diff --git a/include/pugl/gl.h b/include/pugl/gl.h
index dca9a45..36b2887 100644
--- a/include/pugl/gl.h
+++ b/include/pugl/gl.h
@@ -58,7 +58,7 @@ PUGL_BEGIN_DECLS
/**
@defgroup gl OpenGL
OpenGL graphics support.
- @ingroup pugl_c
+ @ingroup pugl
@{
*/
diff --git a/include/pugl/pugl.h b/include/pugl/pugl.h
index 814b39b..14985b9 100644
--- a/include/pugl/pugl.h
+++ b/include/pugl/pugl.h
@@ -70,12 +70,12 @@
PUGL_BEGIN_DECLS
/**
- @defgroup pugl Pugl
+ @defgroup pugldoc Pugl
A minimal portable API for embeddable GUIs.
@{
- @defgroup pugl_c C API
- Public C API.
+ @defgroup pugl Pugl C API
+ Pugl C API.
@{
*/
diff --git a/include/pugl/stub.h b/include/pugl/stub.h
index fd62ff0..61791fd 100644
--- a/include/pugl/stub.h
+++ b/include/pugl/stub.h
@@ -29,7 +29,7 @@ PUGL_BEGIN_DECLS
/**
@defgroup stub Stub
Native graphics support.
- @ingroup pugl_c
+ @ingroup pugl
@{
*/
diff --git a/include/pugl/vulkan.h b/include/pugl/vulkan.h
index a2755f9..487ecda 100644
--- a/include/pugl/vulkan.h
+++ b/include/pugl/vulkan.h
@@ -41,7 +41,7 @@ PUGL_BEGIN_DECLS
Vulkan library, and a portable function to create a Vulkan surface for a
view, which hides the platform-specific implementation details.
- @ingroup pugl_c
+ @ingroup pugl
@{
*/
diff --git a/waflib b/waflib
-Subproject 54f837713a447a49f3be2d47e22364f8420c5f0
+Subproject 5741309b98a05bb0ac3166855a567b936779d75
diff --git a/wscript b/wscript
index 9cceeef..d95f0a1 100644
--- a/wscript
+++ b/wscript
@@ -671,7 +671,10 @@ def build(bld):
uselib=['GL', 'M'])
if bld.env.DOCS:
- autowaf.build_dox(bld, 'PUGL', PUGL_VERSION, top, out)
+ autowaf.build_dox(
+ bld, 'PUGL', PUGL_VERSION, top, out, install_man=False)
+ bld.install_files('${MANDIR}/man3', 'doc/man/man3/pugl.3')
+ bld.install_files('${MANDIR}/man3', 'doc/man/man3/puglxx.3')
def test(tst):