Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 1 | # Copyright (c) 2016 Comcast Cable Communications Management, LLC. |
| 2 | # |
| 3 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | # you may not use this file except in compliance with the License. |
| 5 | # You may obtain a copy of the License at: |
| 6 | # |
| 7 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | # |
| 9 | # Unless required by applicable law or agreed to in writing, software |
| 10 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | # See the License for the specific language governing permissions and |
| 13 | # limitations under the License. |
| 14 | |
| 15 | # |
| 16 | # Build the documentation |
| 17 | # |
| 18 | |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 19 | # Default target |
| 20 | .PHONY: all |
| 21 | all: doxygen |
| 22 | |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 23 | # These should be passed in by the root Makefile |
| 24 | WS_ROOT ?= $(CURDIR)/.. |
| 25 | BR ?= $(WS_ROOT)/build-root |
Chris Luke | 36d2506 | 2016-09-22 20:52:26 -0400 | [diff] [blame] | 26 | |
| 27 | # We support MacOS for docs generation |
| 28 | ifeq ($(shell uname),Darwin) |
| 29 | OS_ID = darwin |
| 30 | endif |
| 31 | |
| 32 | # Work out the OS if we haven't already |
Chris Luke | e0d802b | 2016-08-31 10:04:58 -0400 | [diff] [blame] | 33 | OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 34 | |
| 35 | # Package dependencies |
Damjan Marion | 6bbf83a | 2017-01-10 10:39:21 +0100 | [diff] [blame] | 36 | DOC_DEB_DEPENDS = doxygen graphviz python-pyparsing python-jinja2 |
| 37 | DOC_RPM_DEPENDS = doxygen graphviz pyparsing python-jinja2 |
Marco Varlese | 85bb917 | 2017-02-02 21:33:09 +0100 | [diff] [blame] | 38 | DOC_SUSE_RPM_DEPENDS = doxygen graphviz python-pyparsing python-Jinja2 |
Chris Luke | 36d2506 | 2016-09-22 20:52:26 -0400 | [diff] [blame] | 39 | DOC_MAC_BIN_DEPENDS = doxygen dot git |
| 40 | DOC_MAC_PY_DEPENDS = pyparsing jinja2 |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 41 | |
| 42 | # Doxygen configuration and our utility scripts |
| 43 | DOXY_DIR ?= $(WS_ROOT)/doxygen |
| 44 | |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 45 | # Primary source directories |
Chris Luke | fdc62ab | 2016-12-28 09:44:47 -0500 | [diff] [blame] | 46 | DOXY_SRC ?= src |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 47 | DOXY_SRC_DIRECTORIES = \ |
Chris Luke | fdc62ab | 2016-12-28 09:44:47 -0500 | [diff] [blame] | 48 | $(DOXY_SRC)/vppinfra \ |
| 49 | $(DOXY_SRC)/svm \ |
| 50 | $(DOXY_SRC)/vlib \ |
| 51 | $(DOXY_SRC)/vlibapi \ |
| 52 | $(DOXY_SRC)/vlibmemory \ |
| 53 | $(DOXY_SRC)/vlibsocket \ |
| 54 | $(DOXY_SRC)/vnet \ |
| 55 | $(DOXY_SRC)/vpp \ |
Pablo Camarillo | 4521afa | 2017-03-16 10:43:05 +0100 | [diff] [blame^] | 56 | $(DOXY_SRC)/vpp-api \ |
| 57 | $(DOXY_SRC)/examples |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 58 | |
| 59 | # Input directories and files |
| 60 | DOXY_INPUT ?= \ |
Chris Luke | 5ccbaa9 | 2016-09-14 12:42:54 -0400 | [diff] [blame] | 61 | $(wildcard $(WS_ROOT)/*.md) \ |
| 62 | $(wildcard $(DOXY_DIR)/*.md) \ |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 63 | $(DOXY_SRC_DIRECTORIES) \ |
Damjan Marion | 1c5ee87 | 2017-01-10 17:07:38 +0100 | [diff] [blame] | 64 | $(DOXY_SRC)/plugins |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 65 | |
Chris Luke | 5ccbaa9 | 2016-09-14 12:42:54 -0400 | [diff] [blame] | 66 | # Strip leading workspace path from input names |
| 67 | DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT)) |
| 68 | |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 69 | # Files to exclude, from pre-Doxygen steps, eg because they're |
| 70 | # selectively compiled. |
| 71 | # Examples would be to exclude non-DPDK related sources when |
| 72 | # there's a DPDK equivalent that conflicts. |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 73 | # These must be left-anchored paths for the regexp below to work. |
| 74 | DOXY_EXCLUDE ?= \ |
Chris Luke | fdc62ab | 2016-12-28 09:44:47 -0500 | [diff] [blame] | 75 | $(DOXY_SRC)/vlib/vlib/buffer.c \ |
Damjan Marion | cb034b9 | 2016-12-28 18:38:59 +0100 | [diff] [blame] | 76 | $(DOXY_SRC)/vpp-api/lua \ |
Pablo Camarillo | 4521afa | 2017-03-16 10:43:05 +0100 | [diff] [blame^] | 77 | $(DOXY_SRC)/examples/sample-plugin |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 78 | |
| 79 | # Generate a regexp for filenames to exclude |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 80 | DOXY_EXCLUDE_REGEXP = ($(subst .,\.,$(shell echo '$(strip $(DOXY_EXCLUDE))' | sed -e 's/ /|/g'))) |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 81 | |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 82 | # Include all the normal source directories in the include file path |
| 83 | DOXY_INCLUDE_PATH = $(DOXY_SRC_DIRECTORIES) |
| 84 | |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 85 | # Find API header directories and include them in the header path. |
| 86 | # This is only useful if VPP and plugins are already built; nothing |
| 87 | # here depends on those targets. We don't build documentation for these |
| 88 | # header files, they're just added to the INCLUDE search path for Doxygen. |
| 89 | _vpp_br = $(shell find "$(BR)" -maxdepth 1 -type d \ |
| 90 | '(' -name build-vpp_debug-native -o -name build-vpp-native ')' -print \ |
| 91 | | sed -e 's@^$(WS_ROOT)/*@@' -e 1q) |
| 92 | ifneq ($(strip $(_vpp_br)),) |
| 93 | DOXY_INCLUDE_PATH += \ |
| 94 | $(_vpp_br)/vlib-api \ |
| 95 | $(_vpp_br)/vpp |
| 96 | # Also include any plugin directories that exist |
| 97 | DOXY_INCLUDE_PATH += \ |
| 98 | $(shell find $(WS_ROOT)/$(_vpp_br)/plugins -maxdepth 1 -type d | sed -e 's@^$(WS_ROOT)/*@@') |
| 99 | endif |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 100 | |
| 101 | # Discover if we have CPP available |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 102 | _cpp = $(shell which cpp) |
| 103 | ifneq ($(strip $(_cpp)),) |
| 104 | # Add whatever directories CPP normally includes to the header path |
| 105 | DOXY_INCLUDE_PATH += $(shell set -e; $(_cpp) -v </dev/null 2>&1 | awk 'f&&/^ /{print $$1} /^\#include/{f=1}') |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 106 | endif |
Chris Luke | 16bcf7d | 2016-09-01 14:31:46 -0400 | [diff] [blame] | 107 | |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 108 | # Target directory for doxygen output |
| 109 | DOXY_OUTPUT ?= $(BR)/docs |
| 110 | |
| 111 | # Siphoned fragments end up in here |
| 112 | SIPHON_INPUT ?= $(DOXY_OUTPUT)/siphon_fragments |
| 113 | |
| 114 | # Siphoned fragements are processed into here |
| 115 | SIPHON_OUTPUT ?= $(DOXY_OUTPUT)/siphon_docs |
| 116 | |
| 117 | # Extra document inputs that are processed in addition to DOXY_INPUT |
| 118 | EXTRA_DOXY_INPUT += $(SIPHON_OUTPUT) |
| 119 | |
| 120 | # All the siphon types we know about |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 121 | SIPHONS ?= clicmd syscfg |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 122 | |
| 123 | SIPHON_FILES = $(addprefix $(SIPHON_INPUT)/,$(addsuffix .siphon,$(SIPHONS))) |
| 124 | SIPHON_DOCS = $(addprefix $(SIPHON_OUTPUT)/,$(addsuffix .md,$(SIPHONS))) |
Chris Luke | c3f92ad | 2016-10-05 15:45:19 -0400 | [diff] [blame] | 125 | SIPHON_ITEMLIST = $(addprefix $(SIPHON_OUTPUT)/,$(addsuffix .itemlist,$(filter clicmd,$(SIPHONS)))) |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 126 | |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 127 | $(BR)/.doxygen-bootstrap.ok: Makefile |
Damjan Marion | 6bbf83a | 2017-01-10 10:39:21 +0100 | [diff] [blame] | 128 | @echo "Checking whether dependencies for Doxygen are installed..." |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 129 | ifeq ($(OS_ID),ubuntu) |
Damjan Marion | 6bbf83a | 2017-01-10 10:39:21 +0100 | [diff] [blame] | 130 | @set -e; inst=; \ |
| 131 | for i in $(DOC_DEB_DEPENDS); do \ |
| 132 | dpkg-query --show $$i >/dev/null 2>&1 || inst="$$inst $$i"; \ |
| 133 | done; \ |
| 134 | if [ "$$inst" ]; then \ |
| 135 | sudo apt-get update; \ |
| 136 | sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \ |
| 137 | fi |
Chris Luke | 3542514 | 2016-09-09 20:16:04 -0400 | [diff] [blame] | 138 | @if [ ! -s /usr/lib/graphviz/config6a ]; then \ |
Dave Wallace | c8c5335 | 2017-02-17 00:10:53 -0500 | [diff] [blame] | 139 | echo "Rebuilding system Graphviz configuration."; \ |
Chris Luke | c87fa6d | 2016-09-09 17:51:42 -0400 | [diff] [blame] | 140 | sudo dot -c; \ |
| 141 | fi |
Damjan Marion | 6bbf83a | 2017-01-10 10:39:21 +0100 | [diff] [blame] | 142 | else ifneq ("$(wildcard /etc/redhat-release)","") |
| 143 | @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS) |
Chris Luke | 36d2506 | 2016-09-22 20:52:26 -0400 | [diff] [blame] | 144 | else ifeq ($(OS_ID),darwin) |
| 145 | @set -e; \ |
| 146 | for bin in $(DOC_MAC_BIN_DEPENDS); do \ |
| 147 | which -s $${bin} || (\ |
| 148 | echo "Program '$${bin}' not found, please install it."; \ |
| 149 | false; \ |
| 150 | ); \ |
| 151 | done |
| 152 | @set -e; \ |
| 153 | for py in $(DOC_MAC_PY_DEPENDS); do \ |
| 154 | python -c "import $${py}" >/dev/null 2>&1 || (\ |
| 155 | echo "Python package '$${py}' not found, please install it."; \ |
| 156 | false; \ |
| 157 | ); \ |
| 158 | done |
Marco Varlese | 85bb917 | 2017-02-02 21:33:09 +0100 | [diff] [blame] | 159 | else ifeq ($(OS_ID),opensuse) |
| 160 | @sudo zypper install $(CONFIRM) $(DOC_SUSE_RPM_DEPENDS) |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 161 | else |
Marco Varlese | 85bb917 | 2017-02-02 21:33:09 +0100 | [diff] [blame] | 162 | $(error "Building documentation currently works only on Ubuntu, CentOS, MacOS and OpenSUSE systems.") |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 163 | endif |
| 164 | @touch $@ |
| 165 | |
| 166 | .PHONY: bootstrap-doxygen |
| 167 | bootstrap-doxygen: $(BR)/.doxygen-bootstrap.ok |
| 168 | |
| 169 | .DELETE_ON_ERROR: $(BR)/.doxygen-siphon.dep |
Chris Luke | fdc62ab | 2016-12-28 09:44:47 -0500 | [diff] [blame] | 170 | $(BR)/.doxygen-siphon.dep: Makefile \ |
| 171 | $(addprefix,$(WSROOT),$(DOXY_INPUT)) |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 172 | @echo "Building siphon dependencies..." |
Chris Luke | fdc62ab | 2016-12-28 09:44:47 -0500 | [diff] [blame] | 173 | @rm -f "$@"; for input in $(DOXY_INPUT); do \ |
| 174 | [ -e "$(WS_ROOT)/$$input" ] && \ |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 175 | find "$(WS_ROOT)/$$input" -type f \ |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 176 | \( -name '*.[ch]' -or -name '*.dox' \) -print \ |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 177 | | grep -v -E '^$(WS_ROOT)/$(DOXY_EXCLUDE_REGEXP)' \ |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 178 | | sed -e "s/^/\$$(SIPHON_FILES): /" \ |
| 179 | >> $@; \ |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 180 | done |
| 181 | |
| 182 | # Include the source -> siphon dependencies |
| 183 | -include $(BR)/.doxygen-siphon.dep |
| 184 | |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 185 | # Generate .siphon files that contain fragments of source file that |
| 186 | # relate to the siphons we support. |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 187 | .NOTPARALLEL: $(SIPHON_FILES) |
Damjan Marion | 6bbf83a | 2017-01-10 10:39:21 +0100 | [diff] [blame] | 188 | $(SIPHON_FILES): $(BR)/.doxygen-bootstrap.ok \ |
| 189 | $(DOXY_DIR)/siphon-generate \ |
Chris Luke | fdc62ab | 2016-12-28 09:44:47 -0500 | [diff] [blame] | 190 | $(addprefix,$(WSROOT),$(DOXY_INPUT)) \ |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 191 | $(wildcard $(DOXY_DIR)/siphon/*.py) |
Chris Luke | fdc62ab | 2016-12-28 09:44:47 -0500 | [diff] [blame] | 192 | @echo "Validating source tree..." |
| 193 | @set -e; for input in $(DOXY_INPUT); do \ |
| 194 | if [ ! -e "$(WS_ROOT)/$$input" ]; then \ |
| 195 | echo "ERROR: Input path '$$input' does not exist." >&2; \ |
| 196 | exit 1; \ |
| 197 | fi; \ |
| 198 | done |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 199 | @rm -rf "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)" |
| 200 | @mkdir -p "$(SIPHON_INPUT)" "$(SIPHON_OUTPUT)" |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 201 | @touch $(SIPHON_INPUT)/files |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 202 | @echo "Collating source file list for siphoning..." |
| 203 | @for input in $(DOXY_INPUT); do \ |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 204 | cd "$(WS_ROOT)"; \ |
| 205 | find "$$input" -type f \ |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 206 | \( -name '*.[ch]' -or -name '*.dox' \) -print \ |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 207 | | grep -v -E '^$(DOXY_EXCLUDE_REGEXP)' \ |
Chris Luke | d4024f5 | 2016-09-06 09:32:36 -0400 | [diff] [blame] | 208 | >> $(SIPHON_INPUT)/files; \ |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 209 | done |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 210 | @echo "Generating siphons..." |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 211 | @set -e; \ |
| 212 | cd "$(WS_ROOT)"; \ |
| 213 | $(DOXY_DIR)/siphon-generate \ |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 214 | --output="$(SIPHON_INPUT)" \ |
| 215 | "@$(SIPHON_INPUT)/files" |
| 216 | |
Chris Luke | c3f92ad | 2016-10-05 15:45:19 -0400 | [diff] [blame] | 217 | # Evaluate this to build a siphon doc output target for each desired |
| 218 | # output type: |
| 219 | # $(eval $(call siphon-process,file_extension,output_type_name)) |
| 220 | define siphon-process |
| 221 | $(SIPHON_OUTPUT)/%.$(1): $(SIPHON_INPUT)/%.siphon \ |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 222 | $(DOXY_DIR)/siphon-process \ |
| 223 | $(wildcard $(DOXY_DIR)/siphon/*.py) \ |
Chris Luke | c3f92ad | 2016-10-05 15:45:19 -0400 | [diff] [blame] | 224 | $(wildcard $(DOXY_DIR)/siphon_templates/$(2)/*/*.$(1)) |
| 225 | @echo "Processing siphon for $(2) from $$(notdir $$<)..." |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 226 | @set -e; \ |
| 227 | cd "$(WS_ROOT)"; \ |
| 228 | $(DOXY_DIR)/siphon-process \ |
Chris Luke | c3f92ad | 2016-10-05 15:45:19 -0400 | [diff] [blame] | 229 | --type=$$(basename $$(notdir $$<)) \ |
| 230 | --format=$(2) \ |
| 231 | --output="$$@" \ |
| 232 | "$$<" |
| 233 | endef |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 234 | |
Chris Luke | c3f92ad | 2016-10-05 15:45:19 -0400 | [diff] [blame] | 235 | # Process the .siphon source fragments and render them into doxygen flavored |
| 236 | # markdown documentation |
| 237 | .DELETE_ON_ERROR: $(SIPHON_DOCS) |
| 238 | $(eval $(call siphon-process,md,markdown)) |
| 239 | |
| 240 | # Process the .siphon source fragments and render them into a list of cli |
| 241 | # commands. |
| 242 | .DELETE_ON_ERROR: $(SIPHON_ITEMLIST) |
| 243 | $(eval $(call siphon-process,itemlist,itemlist)) |
| 244 | |
| 245 | # This target can be used just to generate the siphoned things |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 246 | .PHONY: doxygen-siphon |
Damjan Marion | 6bbf83a | 2017-01-10 10:39:21 +0100 | [diff] [blame] | 247 | doxygen-siphon: $(SIPHON_DOCS) $(SIPHON_ITEMLIST) |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 248 | |
| 249 | # Generate the doxygen docs |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 250 | .PHONY: doxygen |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 251 | doxygen: $(SIPHON_DOCS) |
| 252 | @mkdir -p "$(DOXY_OUTPUT)" |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 253 | @echo "Running Doxygen..." |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 254 | set -e; cd "$(WS_ROOT)"; \ |
| 255 | ROOT="$(WS_ROOT)" \ |
| 256 | BUILD_ROOT="$(BR)" \ |
| 257 | INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT)) $(EXTRA_DOXY_INPUT)" \ |
Chris Luke | 16bcf7d | 2016-09-01 14:31:46 -0400 | [diff] [blame] | 258 | INCLUDE_PATH="$(DOXY_INCLUDE_PATH)" \ |
Chris Luke | 3b48093 | 2016-09-07 13:28:59 -0400 | [diff] [blame] | 259 | EXCLUDE="$(DOXY_EXCLUDE)" \ |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 260 | HTML=YES \ |
| 261 | VERSION="`git describe --tags --dirty`" \ |
| 262 | doxygen $(DOXY_DIR)/doxygen.cfg |
| 263 | |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 264 | .PHONY: wipe-doxygen |
Chris Luke | 54ccf22 | 2016-07-25 16:38:11 -0400 | [diff] [blame] | 265 | wipe-doxygen: |
| 266 | rm -rf "$(BR)/docs" "$(BR)/.doxygen-siphon.d" |
| 267 | |
Chris Luke | 90f52bf | 2016-09-12 08:55:13 -0400 | [diff] [blame] | 268 | .PHONY: clean |
| 269 | clean: wipe-doxygen |