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