Merge "configure: support --enable-pic for generic-gnu"
[profile/ivi/libvpx.git] / docs.mk
1 ##
2 ##  Copyright (c) 2010 The VP8 project authors. All Rights Reserved.
3 ##
4 ##  Use of this source code is governed by a BSD-style license and patent
5 ##  grant that can be found in the LICENSE file in the root of the source
6 ##  tree. All contributing project authors may be found in the AUTHORS
7 ##  file in the root of the source tree.
8 ##
9
10
11 INSTALL_MAPS += docs/%    docs/%
12 INSTALL_MAPS += src/%     %
13 INSTALL_MAPS += %         %
14
15 # Static documentation authored in doxygen
16 CODEC_DOX :=    mainpage.dox \
17                 keywords.dox \
18                 usage.dox \
19                 usage_cx.dox \
20                 usage_dx.dox \
21
22 # Other doxy files sourced in Markdown
23 TXT_DOX-$(CONFIG_VP8)          += vp8_api1_migration.dox
24 vp8_api1_migration.dox.DESC     = VP8 API 1.x Migration
25
26 TXT_DOX = $(call enabled,TXT_DOX)
27
28 %.dox: %.txt
29         @echo "    [DOXY] $@"
30         @$(SRC_PATH_BARE)/examples/gen_example_doxy.php \
31              $(@:.dox=)  "$($@.DESC)" > $@ < $<
32
33
34 EXAMPLE_PATH += $(SRC_PATH_BARE) #for CHANGELOG, README, etc
35
36 doxyfile: libs.doxy_template libs.doxy examples.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