From: Alexander Stein <alexander.stein@mailbox.org>
To: linux-gpio@vger.kernel.org
Cc: Alexander Stein <alexander.stein@mailbox.org>
Subject: [libgpiod] [PATCH 2/5] doc: Use autotoolized Doxyfile
Date: Sat, 8 Aug 2020 11:59:41 +0200 [thread overview]
Message-ID: <20200808095944.188479-3-alexander.stein@mailbox.org> (raw)
In-Reply-To: <20200808095944.188479-1-alexander.stein@mailbox.org>
This has several advantages:
* More simplified Makefile.am
* Actually used doxygen config is available as a file
* Building doc out-of-tree is possible
Signed-off-by: Alexander Stein <alexander.stein@mailbox.org>
---
.gitignore | 1 +
Doxyfile => Doxyfile.in | 3 ++-
Makefile.am | 4 +---
configure.ac | 1 +
4 files changed, 5 insertions(+), 4 deletions(-)
rename Doxyfile => Doxyfile.in (95%)
diff --git a/.gitignore b/.gitignore
index 488d9d6..a77efde 100644
--- a/.gitignore
+++ b/.gitignore
@@ -10,6 +10,7 @@ doc
# autotools stuff
.deps/
.libs/
+Doxyfile
Makefile
Makefile.in
aclocal.m4
diff --git a/Doxyfile b/Doxyfile.in
similarity index 95%
rename from Doxyfile
rename to Doxyfile.in
index b194095..8c6d591 100644
--- a/Doxyfile
+++ b/Doxyfile.in
@@ -10,6 +10,7 @@
# General configuration
PROJECT_NAME = libgpiod
+PROJECT_NUMBER = @VERSION_STR@
OUTPUT_DIRECTORY = doc
OUTPUT_LANGUAGE = English
EXTRACT_ALL = NO
@@ -48,7 +49,7 @@ WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_FORMAT =
WARN_LOGFILE =
-INPUT = include/gpiod.h
+INPUT = @top_srcdir@/include/gpiod.h @top_srcdir@/bindings/cxx/gpiod.hpp
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
REFERENCED_BY_RELATION = YES
diff --git a/Makefile.am b/Makefile.am
index d3f57b2..72e6a25 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -29,9 +29,7 @@ SUBDIRS += bindings
if HAS_DOXYGEN
doc:
- @(cat Doxyfile; \
- echo PROJECT_NUMBER = $(VERSION_STR); \
- echo INPUT += bindings/cxx/gpiod.hpp) | doxygen -
+ @doxygen Doxyfile
.PHONY: doc
clean-local:
diff --git a/configure.ac b/configure.ac
index 008499d..c2d9f99 100644
--- a/configure.ac
+++ b/configure.ac
@@ -207,6 +207,7 @@ if test "x$has_doxygen" = xfalse
then
AC_MSG_NOTICE([doxygen not found - documentation cannot be generated])
fi
+AM_COND_IF([HAS_DOXYGEN], [AC_CONFIG_FILES([Doxyfile])])
if test "x$cross_compiling" = xno
then
--
2.28.0
next prev parent reply other threads:[~2020-08-08 10:00 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-08-08 9:59 [libgpiod] [PATCH 0/5] Documentation improvements Alexander Stein
2020-08-08 9:59 ` [libgpiod] [PATCH 1/5] doc: Fix doxygen warnings Alexander Stein
2020-08-08 9:59 ` Alexander Stein [this message]
2020-08-13 18:39 ` [libgpiod] [PATCH 2/5] doc: Use autotoolized Doxyfile Bartosz Golaszewski
2020-08-08 9:59 ` [libgpiod] [PATCH 3/5] doc: Fix doxygen warning Alexander Stein
2020-08-08 9:59 ` [libgpiod] [PATCH 4/5] doc: Remove obsolete PERL_PATH Alexander Stein
2020-08-08 9:59 ` [libgpiod] [PATCH 5/5] doc: Add @file to headers Alexander Stein
2020-08-10 16:49 ` [libgpiod] [PATCH 0/5] Documentation improvements Bartosz Golaszewski
2020-08-11 1:39 ` Kent Gibson
2020-08-11 18:24 ` Alexander Stein
2020-08-11 18:59 ` Bartosz Golaszewski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200808095944.188479-3-alexander.stein@mailbox.org \
--to=alexander.stein@mailbox.org \
--cc=linux-gpio@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).