mirror/openvpn
0
0
Fork 0
mirror of https://github.com/OpenVPN/openvpn.git synced 2024-09-19 19:42:30 +02:00
Code

doxygen: add make target and use relative paths

Browse Source 
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>
This commit is contained in:
Steffan Karger 2017-11-08 13:12:54 +01:00 committed by Gert Doering
parent 2ddb527abe
commit 66bf378e68
6 changed files with 35 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -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/

5
Makefile.am
View File

@ -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

4
configure.ac
View File

@ -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

2
doc/Makefile.am
View File

@ -14,6 +14,8 @@ MAINTAINERCLEANFILES = \
CLEANFILES = openvpn.8.html
SUBDIRS = doxygen
dist_doc_DATA = \
management-notes.txt

21
doc/doxygen/Makefile.am Normal file
View File

@ -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

6
doc/doxygen/openvpn.doxyfile → doc/doxygen/openvpn.doxyfile.in
View File

@ -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 \