aboutsummaryrefslogtreecommitdiffstats
path: root/Makefile
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2016-05-03 16:34:59 -0400
committerDave Barach <openvpp@barachs.net>2016-05-13 17:23:36 +0000
commitb585097048884e063ac25aecc26a6802ee3faa4d (patch)
tree81ea056965937bfcb373f28b83ca51c188ddc4a6 /Makefile
parent94b1442a6731bb879797c016a8febaec2f2ae7c9 (diff)
VPP-57 Add Doxygen to VPP
- Configures Doxygen. - Adds a source filter to do magic on our use of the preprocessor to do constructor stuff to make Doxygen grok it better. - Adds a convenience helper to the root Makefile. - Adds a README.md to the root directory (and which Doxygem uses as its "mainpage". - Add several other documentative files. - Currently using SVG for call graphs, though this may have a load-time performance impact in browsers. Change-Id: I25fc6fb5bf634319dcb36a7f0e32031921c125ac Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile25
1 files changed, 25 insertions, 0 deletions
diff --git a/Makefile b/Makefile
index 8050f876e5e..dee25667db6 100644
--- a/Makefile
+++ b/Makefile
@@ -39,7 +39,9 @@ endif
RPM_DEPENDS_GROUPS = 'Development Tools'
RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
+#RPM_DEPENDS += doxygen # TODO
EPEL_DEPENDS = libconfuse-devel ganglia-devel
+#EPEL_DEPENDS += graphviz # TODO
ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
@@ -209,3 +211,26 @@ ctags: ctags.files
cscope: cscope.files
@cscope -b -q -v
+
+DOXY_INPUT = \
+ README.md \
+ vppinfra \
+ svm \
+ vlib \
+ vlib-api \
+ vnet \
+ vpp \
+ vpp-api
+
+.PHONY: doxygen
+doxygen:
+ @mkdir -p "$(BR)/docs"
+ ROOT="$(WS_ROOT)" \
+ BUILD_ROOT="$(BR)" \
+ INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT))" \
+ HTML=YES \
+ VERSION="`git describe --tags --dirty`" \
+ doxygen doxygen/doxygen.cfg
+
+wipe-doxygen:
+ rm -rf "$(BR)/docs"