a87f454e7b5efb65e854fad99e8715b5832f9e19
[keystone-rtos/wdtimer.git] / docs / Module.xs
1 /******************************************************************************
2  * FILE PURPOSE: WatchdogTimer DOCS Module specification file.
3  ******************************************************************************
4  * FILE NAME: module.xs
5  *
6  * DESCRIPTION: 
7  *  This file contains the module specification for the Watchdog Timer Module Documentation .
8  *
9  * Copyright (C) 2012-2015, Texas Instruments, Inc.
10  *****************************************************************************/
12 /* Load the library utility. */
13 var libUtility = xdc.loadCapsule ("../build/buildlib.xs");
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: WatchdogTimer_document_generation\n";
25     Pkg.makePrologue += "WatchdogTimer_document_generation:\n";
26     Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";
27     Pkg.makePrologue += "\t @echo Generating WatchdogTimer Documentation\n";
28     Pkg.makePrologue += "\t doxygen docs/Doxyfile\n";
29     Pkg.makePrologue += "\t @echo WatchdogTimer Documentation Generated \n";
30     Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";
32     /* Add the documentation file to the package. */
33     Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/WatchdogTimerDocs.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_WatchdogTimer.pdf";
41     if (lldInstallType == "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 WatchdogTimer 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 WatchdogTimer Eclipse Plugin Generated \n";
50         Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";
51     }   
52 }