docs/Module.xs

   1 /******************************************************************************
   2  * FILE PURPOSE: Fault Management Library DOCS Module specification file.
   3  ******************************************************************************
   4  * FILE NAME: module.xs
   5  *
   6  * DESCRIPTION:
   7  *  This file contains the module specification for the Fault Management Lib Documentation .
   8  *
   9  * Copyright (C) 2012, 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 += "release: fault_mgmtlib_document_generation\n";
  25     Pkg.makePrologue += "fault_mgmtlib_document_generation:\n";
  26     Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";
  27     Pkg.makePrologue += "\t @echo Generating Fault Management Lib Documentation\n";
  28     Pkg.makePrologue += "\t doxygen docs/Doxyfile\n";
  29     Pkg.makePrologue += "\t @echo Fault Management Library Documentation Generated \n";
  30     Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";
  31
  32     /* Add the documentation file to the package. */
  33     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/fault_mgmtlibDocs.chm";
  34     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tifooter.htm";
  35     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tiheader.htm";
  36     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tilogo.gif";
  37     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/titagline.gif";
  38     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/doxygen";
  39     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/ReleaseNotes_fault_mgmt.pdf";
  40
  41     if (fault_mgmtlibInstallType == "SETUP")
  42     {
  43         /* Generate the ECLIPSE Plugin Generation */
  44         Pkg.makePrologue += "all: eclipse_plugin_generation\n";
  45         Pkg.makePrologue += "eclipse_plugin_generation:\n";
  46         Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";
  47         Pkg.makePrologue += "\t @echo RM LLD Eclipse Plugin Generation\n";
  48         Pkg.makePrologue += "\t xs xdc.tools.eclipsePluginGen -o . -x ./eclipseDocs/sample.xml -c ./eclipseDocs/toc_cdoc_sample.xml\n";
  49         Pkg.makePrologue += "\t @echo RM LLD Eclipse Plugin Generated \n";
  50         Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";
  51     }
  52 }
  53