1 ## 2 ## Copyright (c) 2010 The WebM project authors. All Rights Reserved. 3 ## 4 ## Use of this source code is governed by a BSD-style license 5 ## that can be found in the LICENSE file in the root of the source 6 ## tree. An additional intellectual property rights grant can be found 7 ## in the file PATENTS. All contributing project authors may 8 ## be found in the AUTHORS file in the root of the source tree. 9 ## 10 11 12 INSTALL_MAPS += docs/% docs/% 13 INSTALL_MAPS += src/% % 14 INSTALL_MAPS += % % 15 16 # Static documentation authored in doxygen 17 CODEC_DOX := mainpage.dox \ 18 keywords.dox \ 19 usage.dox \ 20 usage_cx.dox \ 21 usage_dx.dox \ 22 23 # Other doxy files sourced in Markdown 24 TXT_DOX = $(call enabled,TXT_DOX) 25 26 %.dox: %.txt 27 @echo " [DOXY] $@" 28 @$(SRC_PATH_BARE)/examples/gen_example_doxy.php \ 29 $(@:.dox=) "$($@.DESC)" > $@ < $< 30 31 32 EXAMPLE_PATH += $(SRC_PATH_BARE) #for CHANGELOG, README, etc 33 EXAMPLE_PATH += $(SRC_PATH_BARE)/examples 34 35 doxyfile: $(if $(findstring examples, $(ALL_TARGETS)),examples.doxy) 36 doxyfile: libs.doxy_template libs.doxy 37 @echo " [CREATE] $@" 38 @cat $^ > $@ 39 @echo "STRIP_FROM_PATH += $(SRC_PATH_BARE) $(BUILD_ROOT)" >> $@ 40 @echo "INPUT += $(addprefix $(SRC_PATH_BARE)/,$(CODEC_DOX))" >> $@; 41 @echo "INPUT += $(TXT_DOX)" >> $@; 42 @echo "EXAMPLE_PATH += $(EXAMPLE_PATH)" >> $@ 43 44 CLEAN-OBJS += doxyfile $(wildcard docs/html/*) 45 docs/html/index.html: doxyfile $(CODEC_DOX) $(TXT_DOX) 46 @echo " [DOXYGEN] $<" 47 @doxygen $< 48 DOCS-yes += docs/html/index.html 49 50 DIST-DOCS-yes = $(wildcard docs/html/*) 51 DIST-DOCS-$(CONFIG_CODEC_SRCS) += $(addprefix src/,$(CODEC_DOX)) 52 DIST-DOCS-$(CONFIG_CODEC_SRCS) += src/libs.doxy_template 53 DIST-DOCS-yes += CHANGELOG 54 DIST-DOCS-yes += README 55