ti/dsplib/MakedocsBundle.mk

   1 # ==============================================================================
   2 # File            : MakedocsBundle.mk
   3 # Description     :
   4 #
   5 #   GNU makefile to generate DSPLIB bundle documentation using Doxygen
   6 #
   7 # ==============================================================================
   8
   9
  10 # Common paths
  11 DSPLIBPATH = ../../
  12 SWMPATH = docs/manifest
  13 DOXPATH = docs/doxygen
  14 DOXHTML = $(DOXPATH)/html
  15 ECOHTML = $(DOXPATH)/html
  16 SWMHTML = $(SWMPATH)/html
  17
  18 TI_DOXYGEN_TEMPLATES ?= ../docs/doxygen/TI_Templates
  19
  20 # Document targets
  21 USAGE_DOC          = ./docs/DSPLIB_Users_Manual.chm
  22 MANIFEST_DOC       = ./docs/DSPLIB_Software_Manifest.chm
  23 RELEASE_DOC_BUNDLE = ./$(DOXPATH)/release.chm
  24 #ECLIPSE_DIR  = ./eclipse/plugins
  25
  26 # Redirection script
  27 REDIRECT = $(SWTOOLS_PATH)/redirect.js
  28
  29
  30 #release: $(USAGE_DOC) $(MANIFEST_DOC) $(ECLIPSE_DIR)
  31 release: $(USAGE_DOC) $(MANIFEST_DOC)
  32
  33 releasenotes : $(RELEASE_DOC_BUNDLE)
  34
  35 $(RELEASE_DOC_BUNDLE): ./docs/doxygen/release.h
  36         -@echo generating Release Notes ...
  37         if test ! -d ./docs/doxygen/tmp; then mkdir ./docs/doxygen/tmp; fi
  38         cp $(TI_DOXYGEN_TEMPLATES)/*.* ./docs/doxygen/tmp
  39         doxygen $(SWTOOLS_PATH)/docs/doxygen/bundlerelDoxyfile
  40         @xs -f $(SWTOOLS_PATH)/bundlerelease.js
  41         -@$(RMDIR) ./docs/doxygen/tmp
  42
  43 genbundledocs $(USAGE_DOC): ./$(DOXPATH)/doxygen.h
  44         -@echo Generating DSPLIB bundle documentation ...
  45         -@echo copying tirex folder
  46         cp -r ../.metadata .
  47         if test ! -d $(DOXHTML); then mkdir $(DOXHTML); fi
  48         cp $(TI_DOXYGEN_TEMPLATES)/*.* $(DOXHTML)
  49         @echo Pulling in DSPLIB API Documentation ...
  50         @cp -fru $(DSPLIBPATH)/dsplib/$(ECOHTML) $(DOXHTML)/dsplib_html
  51         doxygen ./$(DOXPATH)/Doxyfile
  52         xs -f $(REDIRECT) ./doxygen/html/index.html > ./docs/DSPLIB_Users_Manual.html
  53
  54 $(MANIFEST_DOC): ./$(SWMPATH)/manifest.h
  55         -@echo generating Software Manifest ...
  56         if test ! -d ./$(SWMHTML); then mkdir ./$(SWMHTML); fi
  57         @cp $(TI_DOXYGEN_TEMPLATES)/*.* ./$(SWMHTML)
  58         doxygen ./$(SWMPATH)/Doxyfile
  59         xs -f $(REDIRECT) ./manifest/html/index.html > ./docs/DSPLIB_Software_Manifest.html
  60
  61 #$(ECLIPSE_DIR): ./eclipse/dsplib.xml ./eclipse/dsplib_toc.xml
  62 #       -@echo generating Eclipse Plugin ...
  63 #       xs xdc.tools.eclipsePluginGen -o . -x ./eclipse/dsplib.xml -c ./eclipse/dsplib_toc.xml
  64
  65
  66 # End of Makedocs.mk