docs.mk 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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. INSTALL_MAPS += docs/% docs/%
  11. INSTALL_MAPS += src/% %
  12. INSTALL_MAPS += % %
  13. # Static documentation authored in doxygen
  14. CODEC_DOX := mainpage.dox \
  15. keywords.dox \
  16. usage.dox \
  17. usage_cx.dox \
  18. usage_dx.dox \
  19. # Other doxy files sourced in Markdown
  20. TXT_DOX = $(call enabled,TXT_DOX)
  21. EXAMPLE_PATH += $(SRC_PATH_BARE) #for CHANGELOG, README, etc
  22. EXAMPLE_PATH += $(SRC_PATH_BARE)/examples
  23. doxyfile: $(if $(findstring examples, $(ALL_TARGETS)),examples.doxy)
  24. doxyfile: libs.doxy_template libs.doxy
  25. @echo " [CREATE] $@"
  26. @cat $^ > $@
  27. @echo "STRIP_FROM_PATH += $(SRC_PATH_BARE) $(BUILD_ROOT)" >> $@
  28. @echo "INPUT += $(addprefix $(SRC_PATH_BARE)/,$(CODEC_DOX))" >> $@;
  29. @echo "INPUT += $(TXT_DOX)" >> $@;
  30. @echo "EXAMPLE_PATH += $(EXAMPLE_PATH)" >> $@
  31. CLEAN-OBJS += doxyfile $(wildcard docs/html/*)
  32. docs/html/index.html: doxyfile $(CODEC_DOX) $(TXT_DOX)
  33. @echo " [DOXYGEN] $<"
  34. @doxygen $<
  35. DOCS-yes += docs/html/index.html
  36. DIST-DOCS-yes = $(wildcard docs/html/*)
  37. DIST-DOCS-$(CONFIG_CODEC_SRCS) += $(addprefix src/,$(CODEC_DOX))
  38. DIST-DOCS-$(CONFIG_CODEC_SRCS) += src/libs.doxy_template
  39. DIST-DOCS-yes += CHANGELOG
  40. DIST-DOCS-yes += README