1 /******************************************************************************\r
2 * FILE PURPOSE: PCIE LLD 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 PCIE LLD Documentation.\r
8 *\r
9 * Copyright (C) 2011-2016, 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 += ".PHONY: pcie_lld_document_generation\n";\r
25 Pkg.makePrologue += "release: pcie_lld_document_generation\n";\r
26 Pkg.makePrologue += "docs/doxygen/html/index.html: pcie_lld_document_generation\n";\r
27 Pkg.makePrologue += "pcie_lld_document_generation:\n";\r
28 Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";\r
29 Pkg.makePrologue += "\t @echo Generating PCIE LLD Documentation\n";\r
30 Pkg.makePrologue += "\t doxygen docs/Doxyfile\n";\r
31 Pkg.makePrologue += "\t @echo PCIE LLD Documentation Generated \n";\r
32 Pkg.makePrologue += "\t @echo -------------------------------------------------------\n";\r
33 \r
34 /* Add the documentation file to the package. */\r
35 /*Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/pcieDocs.chm";*/\r
36 /*Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/pcie_sds.doc";*/\r
37 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tifooter.htm";\r
38 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tiheader.htm";\r
39 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/tilogo.gif";\r
40 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/titagline.gif";\r
41 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/ReleaseNotes_PCIE_LLD.pdf"\r
42 /*Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/doxydoc.wmf"*/\r
43 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/PCIE_LLD_2.x_manifest.html"\r
44 /* Add the HTML documentation to the package */\r
45 Pkg.otherFiles[Pkg.otherFiles.length++] = "docs/doxygen";\r
46 \r
47 /* Generate the ECLIPSE Plugin Generation: Only for SETUP Releases. */\r
48 if (driverInstallType == "SETUP")\r
49 {\r
50 Pkg.makePrologue += "all: eclipse_plugin_generation\n";\r
51 Pkg.makePrologue += "eclipse_plugin_generation:\n";\r
52 Pkg.makePrologue += "\t @echo ----------------------------\n";\r
53 Pkg.makePrologue += "\t @echo PCIE LLD Eclipse Plugin Generation\n";\r
54 Pkg.makePrologue += "\t xs xdc.tools.eclipsePluginGen -o . -x ./eclipseDocs/sample.xml -c ./eclipseDocs/toc_cdoc_sample.xml\n";\r
55 Pkg.makePrologue += "\t @echo PCIE LLD Eclipse Plugin Generated \n";\r
56 Pkg.makePrologue += "\t @echo ----------------------------\n";\r
57 }\r
58 }\r
59 \r