docs/Module.xs

   1 /******************************************************************************\r
   2  * FILE PURPOSE: RM DOCS Module specification file.\r
   3  ******************************************************************************\r
   4  * FILE NAME: module.xs\r
   5  *\r
   6  * DESCRIPTION: \r
   7  *  This file contains the module specification for the RM Documentation.\r
   8  *\r
   9  * Copyright (C) 2012-2013, Texas Instruments, Inc.\r
  10  *****************************************************************************/\r
  11 \r
  12 /* Load the library utility. */\r
  13 var libUtility = xdc.loadCapsule ("../build/buildlib.xs");\r
  14 \r
  15 /**************************************************************************\r
  16  * FUNCTION NAME : modBuild\r
  17  **************************************************************************\r
  18  * DESCRIPTION   :\r
  19  *  The function is used to build all the components of the documentation\r
  20  **************************************************************************/\r
  21 function modBuild() \r
  22 {\r
  23     /* Create the actual PROLOGUE Section for the Documentation.*/\r
  24     Pkg.makePrologue += "release: rm_document_generation\n";\r
  25     Pkg.makePrologue += "rm_document_generation:\n";\r
  26     Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";\r
  27     Pkg.makePrologue += "\t @echo Generating RM Documentation\n";\r
  28     Pkg.makePrologue += "\t doxygen docs/Doxyfile\n";\r
  29     Pkg.makePrologue += "\t @echo RM Documentation Generated \n";\r
  30     Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";\r
  31 \r
  32     /* Add the documentation file to the package. */\r
  33     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/rmDocs.chm";\r
  34     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tifooter.htm";\r
  35     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tiheader.htm";\r
  36     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tilogo.gif";\r
  37     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/titagline.gif";\r
  38     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/doxygen";\r
  39     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/RM_SoftwareManifest.pdf";\r
  40     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/ReleaseNotes_RM.pdf";\r
  41 \r
  42     if (lldInstallType == "SETUP")\r
  43     {\r
  44         /* Generate the ECLIPSE Plugin Generation */\r
  45         Pkg.makePrologue += "all: eclipse_plugin_generation\n";\r
  46         Pkg.makePrologue += "eclipse_plugin_generation:\n";\r
  47         Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";\r
  48         Pkg.makePrologue += "\t @echo RM Eclipse Plugin Generation\n";\r
  49         Pkg.makePrologue += "\t xs xdc.tools.eclipsePluginGen -o . -x ./eclipseDocs/sample.xml -c ./eclipseDocs/toc_cdoc_sample.xml\n";\r
  50         Pkg.makePrologue += "\t @echo RM Eclipse Plugin Generated \n";\r
  51         Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";\r
  52     }   \r
  53 }\r
  54 \r