pdk_k2g_1_0_1/packages/ti/csl/docs/Module.xs

   1 /******************************************************************************
   2  * FILE PURPOSE: CSL DOCS Module specification file.
   3  ******************************************************************************
   4  * FILE NAME: module.xs
   5  *
   6  * DESCRIPTION:
   7  *  This file contains the module specification for the CSL Documentation .
   8  *
   9  * Copyright (C) 2011-2015, Texas Instruments, Inc.
  10  *****************************************************************************/
  11
  12 /* Load the library utility. */
  13 var libUtility = xdc.loadCapsule ("../build/buildlib.xs");
  14
  15 /**************************************************************************
  16  * FUNCTION NAME : modBuild
  17  **************************************************************************
  18  * DESCRIPTION   :
  19  *  The function is used to build all the components of the documentation
  20  **************************************************************************/
  21 function modBuild()
  22 {
  23     /* Create the actual PROLOGUE Section for the Documentation.*/
  24     Pkg.makePrologue += ".PHONY: csl_lld_document_generation\n";
  25     Pkg.makePrologue += "release: csl_document_generation\n";
  26     Pkg.makePrologue += "docs/doxygen/html/index.html: csl_lld_document_generation\n";
  27     Pkg.makePrologue += "csl_document_generation:\n";
  28     Pkg.makePrologue += "\t @echo ----------------------------\n";
  29     Pkg.makePrologue += "\t @echo Generating CSL Documentation\n";
  30     Pkg.makePrologue += "\t doxygen docs/Doxyfile\n";
  31     Pkg.makePrologue += "\t @echo CSL Documentation Generated \n";
  32     Pkg.makePrologue += "\t @echo ----------------------------\n";
  33
  34     /* Add the documentation file to the package. */
  35     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tifooter.htm";
  36     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tiheader.htm";
  37     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tilogo.gif";
  38     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/titagline.gif";
  39
  40     /* Add the HTML documentation to the package */
  41     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/doxygen";
  42
  43     /* Add all the .pdf files to the release package. */
  44 /*    Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/CSL-legacy-API-changes.pdf"; */
  45     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/CSL_SoftwareManifest.pdf";
  46     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/ReleaseNotes_CSL.pdf";
  47 }
  48