diff options
author | John Koleszar <jkoleszar@google.com> | 2010-05-18 11:58:33 -0400 |
---|---|---|
committer | John Koleszar <jkoleszar@google.com> | 2010-05-18 11:58:33 -0400 |
commit | 0ea50ce9cb4b65eee6afa1d041fe8beb5abda667 (patch) | |
tree | 1f3b9019f28bc56fd3156f96e5a9653a983ee61b /docs.mk | |
download | libvpx-0ea50ce9cb4b65eee6afa1d041fe8beb5abda667.tar.gz libvpx-0ea50ce9cb4b65eee6afa1d041fe8beb5abda667.tar.bz2 libvpx-0ea50ce9cb4b65eee6afa1d041fe8beb5abda667.zip |
Initial WebM releasev0.9.0
Diffstat (limited to 'docs.mk')
-rw-r--r-- | docs.mk | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/docs.mk b/docs.mk new file mode 100644 index 000000000..3e7b5cdeb --- /dev/null +++ b/docs.mk @@ -0,0 +1,54 @@ +## +## Copyright (c) 2010 The VP8 project authors. All Rights Reserved. +## +## Use of this source code is governed by a BSD-style license and patent +## grant that can be found in the LICENSE file in the root of the source +## tree. All contributing project authors may be found in the AUTHORS +## file in the root of the source tree. +## + + +INSTALL_MAPS += docs/% docs/% +INSTALL_MAPS += src/% % +INSTALL_MAPS += % % + +# Static documentation authored in doxygen +CODEC_DOX := mainpage.dox \ + keywords.dox \ + usage.dox \ + usage_cx.dox \ + usage_dx.dox \ + +# Other doxy files sourced in Markdown +TXT_DOX-$(CONFIG_VP8) += vp8_api1_migration.dox +vp8_api1_migration.dox.DESC = VP8 API 1.x Migration + +TXT_DOX = $(call enabled,TXT_DOX) + +%.dox: %.txt + @echo " [DOXY] $@" + @$(SRC_PATH_BARE)/examples/gen_example_doxy.php \ + $(@:.dox=) "$($@.DESC)" > $@ < $< + + +EXAMPLE_PATH += $(SRC_PATH_BARE) #for CHANGELOG, README, etc + +doxyfile: libs.doxy_template libs.doxy examples.doxy + @echo " [CREATE] $@" + @cat $^ > $@ + @echo "STRIP_FROM_PATH += $(SRC_PATH_BARE) $(BUILD_ROOT)" >> $@ + @echo "INPUT += $(addprefix $(SRC_PATH_BARE)/,$(CODEC_DOX))" >> $@; + @echo "INPUT += $(TXT_DOX)" >> $@; + @echo "EXAMPLE_PATH += $(EXAMPLE_PATH)" >> $@ + +CLEAN-OBJS += doxyfile $(wildcard docs/html/*) +docs/html/index.html: doxyfile $(CODEC_DOX) $(TXT_DOX) + @echo " [DOXYGEN] $<" + @doxygen $< +DOCS-yes += docs/html/index.html + +INSTALL-DOCS-yes = $(wildcard docs/html/*) +INSTALL-DOCS-$(CONFIG_CODEC_SRCS) += $(addprefix src/,$(CODEC_DOX)) +INSTALL-DOCS-$(CONFIG_CODEC_SRCS) += src/libs.doxy_template +INSTALL-DOCS-yes += CHANGELOG +INSTALL-DOCS-yes += README |