doxygen: add make target and use relative paths

Add a make target, such that 'make doxygen' works (both for in-tree and
out-of-tree builds).  This now generates the doxygen in doc/doxygen/,
rather than in doxygen/.

While doing so, instead of genering docs with full path names (e.g.
/home/steffan/dev/openvpn/src/openvpn/crypto.h), use a relative path wrt
the project root (e.g. src/openvpn/crypto.h) in the generated
documentation.  This makes the generated doxygen easier to read.

Signed-off-by: Steffan Karger <steffan.karger@fox-it.com>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <1510143174-15248-1-git-send-email-steffan.karger@fox-it.com>
URL: https://www.mail-archive.com/search?l=mid&q=1510143174-15248-1-git-send-email-steffan.karger@fox-it.com
Signed-off-by: Gert Doering <gert@greenie.muc.de>

diff --git a/.gitignore b/.gitignore
index 45436748306cbbf6af27fca5272f88adc2109af6..18a452022a1e087c6461d1826521eaebbb60a0d8 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -34,7 +34,6 @@ config.sub
 configure
 configure.h
 depcomp
-doxygen/
 stamp-h1
 install-sh
 missing
@@ -51,6 +50,8 @@ msvc-env-local.bat
 config-msvc-local.h
 config-msvc-version.h
 doc/openvpn.8.html
+/doc/doxygen/html/
+/doc/doxygen/latex/
 distro/rpm/openvpn.spec
 distro/systemd/*.service
 sample/sample-keys/sample-ca/

diff --git a/Makefile.am b/Makefile.am
index 87af7241db7377364a2ccd92f07d23959cad631b..773b7867e82001d2b3bf76a569d22642615c15bd 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -46,7 +46,7 @@ EXTRA_DIST = \
        contrib \
        debug
 
-.PHONY: config-version.h
+.PHONY: config-version.h doxygen
 
 if GIT_CHECKOUT
 BUILT_SOURCES = \
@@ -96,3 +96,6 @@ config-version.h:
        else \
                rm -f config-version.h.tmp; \
        fi
+
+doxygen:
+       $(MAKE) -C doc/doxygen doxygen

diff --git a/configure.ac b/configure.ac
index 45aa5017b800ddc47e2294a069ba4dfde9dbe7bb..7f2e34f2c5a00d2d38e39ce834bf96d330e57247 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -1420,6 +1420,9 @@ AC_CONFIG_FILES([
        distro/rpm/Makefile
        distro/rpm/openvpn.spec
        distro/systemd/Makefile
+       doc/Makefile
+       doc/doxygen/Makefile
+       doc/doxygen/openvpn.doxyfile
        include/Makefile
        src/Makefile
        src/compat/Makefile
@@ -1436,7 +1439,6 @@ AC_CONFIG_FILES([
         tests/unit_tests/plugins/auth-pam/Makefile
         vendor/Makefile
        sample/Makefile
-       doc/Makefile
 ])
 AC_CONFIG_FILES([tests/t_client.sh], [chmod +x tests/t_client.sh])
 AC_OUTPUT

diff --git a/doc/Makefile.am b/doc/Makefile.am
index dedd1fa5cf5ee36420a5c51d619482fdd0af77ea..f9e7f4ae143a4a4bd1c68ddbcc9bae231af68ecb 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -14,6 +14,8 @@ MAINTAINERCLEANFILES = \
 
 CLEANFILES = openvpn.8.html
 
+SUBDIRS = doxygen
+
 dist_doc_DATA = \
        management-notes.txt
 

diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am
new file mode 100644 (file)
index 0000000..def0978
--- /dev/null
+++ b/doc/doxygen/Makefile.am
@@ -0,0 +1,21 @@
+#
+#  OpenVPN -- An application to securely tunnel IP networks
+#             over a single UDP port, with support for SSL/TLS-based
+#             session authentication and key exchange,
+#             packet encryption, packet authentication, and
+#             packet compression.
+#
+#  Copyright (C) 2017 Fox-IT B.V. <openvpn@fox-it.com>
+#
+
+MAINTAINERCLEANFILES = \
+       $(srcdir)/Makefile.in
+
+DISTCLEANFILES = openvpn.doxyfile
+
+.PHONY: doxygen
+doxygen: openvpn.doxyfile
+       doxygen openvpn.doxyfile
+
+clean-local:
+       -rm -rf html latex

diff --git a/doc/doxygen/openvpn.doxyfile b/doc/doxygen/openvpn.doxyfile.in
similarity index 98%
rename from doc/doxygen/openvpn.doxyfile
rename to doc/doxygen/openvpn.doxyfile.in
index a7d9728ead466105e2fbde4e5af68773b791c8c4..bb56fff4a176aeb782b1168a130fa674b373904e 100644 (file)
--- a/doc/doxygen/openvpn.doxyfile
+++ b/doc/doxygen/openvpn.doxyfile.in
@@ -6,7 +6,7 @@
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = "OpenVPN"
 PROJECT_NUMBER         =
-OUTPUT_DIRECTORY       = doxygen
+OUTPUT_DIRECTORY       = "@abs_top_builddir@/doc/doxygen"
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
@@ -25,7 +25,7 @@ ABBREVIATE_BRIEF       = "The $name class" \
 ALWAYS_DETAILED_SEC    = NO
 INLINE_INHERITED_MEMB  = NO
 FULL_PATH_NAMES        = YES
-STRIP_FROM_PATH        = ""
+STRIP_FROM_PATH        = "@abs_top_srcdir@"
 STRIP_FROM_INC_PATH    =
 SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = YES # NO
@@ -90,7 +90,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = .
+INPUT                  = "@abs_top_srcdir@"
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.c \
                          *.cc \