From 26c133cb7e20c3049602cb5da21c4ecc20d4aa70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferenc=20W=C3=A1gner?= Date: Thu, 30 Jul 2020 17:58:55 +0200 Subject: [PATCH 1/4] Fix documentation typo in qbrb.h --- include/qb/qbrb.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/qb/qbrb.h b/include/qb/qbrb.h index b2915b6a9..a5176896e 100644 --- a/include/qb/qbrb.h +++ b/include/qb/qbrb.h @@ -268,7 +268,7 @@ ssize_t qb_rb_chunks_used(qb_ringbuffer_t * rb); ssize_t qb_rb_write_to_file(qb_ringbuffer_t * rb, int32_t fd); /** - * Load the saved ring buffer from file into tempory memory. + * Load the saved ring buffer from file into temporary memory. * @param fd file with saved ringbuffer data. * @param flags same flags as passed into qb_rb_open() * @return new ringbuffer instance From 98d3cf9ffba8efd3c66f0d87b0b43ca0a07f09e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferenc=20W=C3=A1gner?= Date: Wed, 23 Sep 2020 22:05:43 +0200 Subject: [PATCH 2/4] Fix section number in doxygen2man manual --- doxygen2man/doxygen2man.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxygen2man/doxygen2man.1 b/doxygen2man/doxygen2man.1 index 2fb850019..c074ff465 100644 --- a/doxygen2man/doxygen2man.1 +++ b/doxygen2man/doxygen2man.1 @@ -6,7 +6,7 @@ .\" * Author: Christine Caulfield .\" * -.TH "DOXYGEN2MAN" "8" "2020-09-09" "" "" +.TH "DOXYGEN2MAN" "1" "2020-09-09" "" "" .SH "NAME" doxygen2man \- A tool to generate man pages from Doxygen XML files .SH "SYNOPSIS" From 3605a8be6cc1a00fdc28bf39fe499d87d38dbb6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferenc=20W=C3=A1gner?= Date: Wed, 23 Sep 2020 22:21:54 +0200 Subject: [PATCH 3/4] Point Doxygen to our examples --- docs/man.dox.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/man.dox.in b/docs/man.dox.in index dc420aa2e..9cb110be1 100644 --- a/docs/man.dox.in +++ b/docs/man.dox.in @@ -1221,14 +1221,14 @@ GENERATE_BUGLIST = NO # that contain example code fragments that are included (see the \include # command). -#EXAMPLE_PATH = +EXAMPLE_PATH = ../examples # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. -#EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = *.c # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands From d474f6ff6e870e75810a9d7fa350b5a425bd887a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ferenc=20W=C3=A1gner?= Date: Thu, 24 Sep 2020 18:01:57 +0200 Subject: [PATCH 4/4] No HTML documentation anymore --- docs/.gitignore | 1 - docs/Makefile.am | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/.gitignore b/docs/.gitignore index 90011c76d..aef77943c 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,4 +1,3 @@ man3 -html xml *.dox diff --git a/docs/Makefile.am b/docs/Makefile.am index f41e90c09..fa1bac6b4 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -256,4 +256,4 @@ endif endif clean-local: - rm -rf html man3 xml + rm -rf man3 xml