The GenDoc application generates HTML documentation from a Visual Studio XML Comment output file. The XML Comment output file includes external XML Comment files which are referenced by source file "include" XML comments.
| CopyUpdateLinks.cmd | |
| UpdateLinks.cmd | Copies the project Link Pages to the CodeDoc project folders. This file should be copied to the CodeDoc root folder and run from there. |
| UpdateLinks.cmd | Copies the project Link Pages to the CodeDoc project folders. This file should be copied to the CodeDoc root folder and run from there. |
ProjectFolder\LinkPages -
Each project can have one or more folders to hold link pages. There
should be a folder named LinkPages. There may also be other folders such
as Links, Diagrams, etc. to qualify the type of links.
LJCDocGen\bin\Debug\Links - There must be an XML file in LJCDocGen\bin\Debug\Links with the name of the project and a suffix of Links. For example: Project LJCDataAccess would require a file named LJCDataAccessLinks.xml. This file identifies the links to be added to the CodeDoc Project page. A link is created on the Project page for each entry.
<?xml version="1.0"?>
<!-- Copyright (c) Lester J. Clark 2021,2022 - All Rights Reserved -->
<!-- LJCDataAccessLinks.xml -->
<Links xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Link>
<Name>..\..\..\..\LJCDataAccess\LJCDataAccess\LinkPages\DataAccessLink.html</Name>
<Text>Data Access Class Diagram</Text>
</Link>
</Links>
The LJCGenDoc project group has five main projects:
| LJCGenDoc | The GenDoc Console Program |
| LJCGenDocLib | The GenDoc Library |
| LJCLJCGenDocDAL | The GenDoc Data Access Layer Library |
| LJCDocXMLObjLib | The GenDoc XML Object Library |
| LJCDocObjLib | The GenDoc DocData Object Library |
The LJCGenDoc project group has two utility/test projects:
| GenDocScript | Generates SQL scripts to add DB Grouping data. |
| TestSyntaxConsole | The console program to test syntax highlighting. |