| Class Program |
|   |
| Code Information |
| Full Name: | FarqenDoc.Program |
| Summary: |
This is the program class, which contains the entry point and static members for the document builder.
See the Main method for details on operation of the program.
|
| Remarks: | |
|   |
| Links |
| Target | Summary |
| Code Index | Back to the documentation root |
| Class CodeMember | Related class |
| Class CodeClass | Related class |
| Method Program.Main | Related method |
|   |
| Methods |
| Name | Summary |
| aTestOverload |
Testing overload handling. This is method A.
|
| aTestOverload |
Testing overload handling. This is method B.
|
| checkForUsage |
Ensures that we never use the same filename twice for a documentation set.
|
| findClass |
Finds a CodeClass from our known classes so we can attach more information to it.
|
| Main |
Main method - takes VS 2005 "/doc" XML files and produces HTML files.
|
| processMembers |
This method examines the code members and extracts things like classes and methods.
|
| processNode |
This recursive method examines XML nodes and builds structures
representing the information on the code it finds.
|
| writeDocuments |
Writes the index to all documentation, then writes the documentation file for each class.
|
|   |
| Properties |
| Name | Summary |
| aTestProperty |
This is a property.
|
|   |
| Fields |
| Name | Summary |
| codeClasses |
Once we have a list of CodeMembers, we can try to interpret them and build
CodeClass definitions.
|
| codeMembers |
As we read the XML, we build CodeMember objects describing the members, which can then be
examined further.
|
| rootInfo |
To facilitate placing a summary and remarks on the index page, we have a root CodeMember.
|
| rootLinks |
To facilitate the placement of recommended reading links on the index page, we have this list of files.
|
| usedFilenames |
This records filenames we have used, so we can create new names for files containing overloads.
|
| workingPath |
This holds the name of the directory where we are currently outputting HTML.
|
| Documentation generated by FarqenDoc © Aaron Oxford 2006 |