From 81e0d83403ba6f52153f50eb8e91f93068c91baf Mon Sep 17 00:00:00 2001 From: Thomas Bernard Date: Tue, 24 Sep 2019 11:20:17 +0200 Subject: [PATCH] build doc with Doxygen --- .gitlab-ci.yml | 1 + .travis.yml | 1 + miniupnpd/Makefile | 4 ++++ miniupnpd/Makefile.linux | 7 ++++++- miniupnpd/Makefile.linux_nft | 2 +- 5 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index fbc03cb..fd3b9e2 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -14,6 +14,7 @@ job_miniupnpd: - "make -j3 -f Makefile.linux && make -f Makefile.linux check" - "make -f Makefile.linux clean" - "make -j3 -f Makefile.linux_nft" + - "make -f Makefile.linux_nft dox" # i686-w64-mingw32-gcc job_miniupnpc: diff --git a/.travis.yml b/.travis.yml index 8aa60c5..806ce45 100644 --- a/.travis.yml +++ b/.travis.yml @@ -56,6 +56,7 @@ script: - 'CONFIG_OPTIONS="--ipv6 --igd2" make -f $MAKEFILE -j3' - 'if [ "$TRAVIS_OS_NAME" = "linux" ] && [ "$PROJECT" = "miniupnpd" ]; then make -f Makefile.linux_nft ; fi' - make -f $MAKEFILE check + - 'if [ "$TRAVIS_OS_NAME" = "linux" ] && [ "$PROJECT" = "miniupnpd" ]; then make -f $MAKEFILE dox ; fi' - if [ "$PROJECT" = "miniupnpc" ]; then INSTALLPREFIX="$HOME/_pythonmodule" make -f $MAKEFILE pythonmodule; fi diff --git a/miniupnpd/Makefile b/miniupnpd/Makefile index 022728d..426fa4e 100644 --- a/miniupnpd/Makefile +++ b/miniupnpd/Makefile @@ -29,6 +29,7 @@ RM = rm -f MV = mv INSTALL = install STRIP = strip +DOXYGEN ?= doxygen # OSNAME and FWNAME are used for building OS or FW dependent code. OSNAME != uname -s @@ -225,6 +226,9 @@ depend: config.h testgetroute.c testportinuse.c testasyncsendto.c \ testssdppktgen.c +dox: miniupnpd.doxyconf + $(DOXYGEN) $> + miniupnpd: config.h $(ALLOBJS) $(CC) $(LDFLAGS) -o $@ $(ALLOBJS) $(LIBS) diff --git a/miniupnpd/Makefile.linux b/miniupnpd/Makefile.linux index 7be3093..d5255c7 100644 --- a/miniupnpd/Makefile.linux +++ b/miniupnpd/Makefile.linux @@ -39,6 +39,7 @@ INSTALL = install STRIP ?= strip PKG_CONFIG ?= pkg-config CP = cp +DOXYGEN ?= doxygen INSTALLPREFIX ?= $(PREFIX)/usr @@ -187,7 +188,7 @@ EXECUTABLES = miniupnpd testupnpdescgen testgetifstats \ testgetroute testasyncsendto testportinuse \ testssdppktgen testminissdp -.PHONY: all clean install depend genuuid +.PHONY: all clean install depend genuuid dox all: $(EXECUTABLES) @@ -202,6 +203,7 @@ clean: $(RM) testssdppktgen.o $(RM) miniupnpdctl.o $(RM) validateupnppermissions validategetifaddr validatessdppktgen + $(RM) -r dox/ install: miniupnpd miniupnpd.8 miniupnpd.conf genuuid \ netfilter/iptables_init.sh netfilter/iptables_removeall.sh \ @@ -284,6 +286,9 @@ depend: config.h testgetroute.c testasyncsendto.c testportinuse.c \ miniupnpdctl.c testssdppktgen.c 2>/dev/null +dox: miniupnpd.doxyconf + $(DOXYGEN) $< + # DO NOT DELETE miniupnpd.o: config.h macros.h upnpglobalvars.h upnppermissions.h diff --git a/miniupnpd/Makefile.linux_nft b/miniupnpd/Makefile.linux_nft index 9c2278d..861e777 100644 --- a/miniupnpd/Makefile.linux_nft +++ b/miniupnpd/Makefile.linux_nft @@ -171,7 +171,7 @@ depend: config.h miniupnpdctl.c 2>/dev/null dox: - doxygen miniupnpd.doxyconf + $(DOXYGEN) miniupnpd.doxyconf # DO NOT DELETE