Home | History | Annotate | Download | only in libvpx
      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-$(CONFIG_VP8)          += vp8_api1_migration.dox
     25 vp8_api1_migration.dox.DESC     = VP8 API 1.x Migration
     26 
     27 TXT_DOX = $(call enabled,TXT_DOX)
     28 
     29 %.dox: %.txt
     30 	@echo "    [DOXY] $@"
     31 	@$(SRC_PATH_BARE)/examples/gen_example_doxy.php \
     32              $(@:.dox=)  "$($@.DESC)" > $@ < $<
     33 
     34 
     35 EXAMPLE_PATH += $(SRC_PATH_BARE) #for CHANGELOG, README, etc
     36 
     37 doxyfile: $(if $(findstring examples, $(ALL_TARGETS)),examples.doxy)
     38 doxyfile: libs.doxy_template libs.doxy
     39 	@echo "    [CREATE] $@"
     40 	@cat $^ > $@
     41 	@echo "STRIP_FROM_PATH += $(SRC_PATH_BARE) $(BUILD_ROOT)" >> $@
     42 	@echo "INPUT += $(addprefix $(SRC_PATH_BARE)/,$(CODEC_DOX))" >> $@;
     43 	@echo "INPUT += $(TXT_DOX)" >> $@;
     44 	@echo "EXAMPLE_PATH += $(EXAMPLE_PATH)" >> $@
     45 
     46 CLEAN-OBJS += doxyfile $(wildcard docs/html/*)
     47 docs/html/index.html: doxyfile $(CODEC_DOX) $(TXT_DOX)
     48 	@echo "    [DOXYGEN] $<"
     49 	@doxygen $<
     50 DOCS-yes += docs/html/index.html
     51 
     52 DIST-DOCS-yes = $(wildcard docs/html/*)
     53 DIST-DOCS-$(CONFIG_CODEC_SRCS) += $(addprefix src/,$(CODEC_DOX))
     54 DIST-DOCS-$(CONFIG_CODEC_SRCS) += src/libs.doxy_template
     55 DIST-DOCS-yes                  += CHANGELOG
     56 DIST-DOCS-yes                  += README
     57