Configuration
This contributed tool includes a configuration program that can be used to control
how the tool operates and the content and format of the output that is created.
Header Tags
This panel identifies the header tags to be included in the documentation.
Document Generation
This panel is used to set configuration options controlling the generation of the
document content.
- include documentation for the LOCAL (private) property and FUNCTION definitions
- include the assignment of constants for PROPERTIES
- set modification date/time stamp to match source file
- the location where the documentation files will be created
- create documentation in a folder OUTSIDE of the project;
- if not selected, the documentation will be placed into a 'pvxdocs' folder in
the root of the project
- the organization of the files in the output folder
- create a project-specific sub-folder; this is useful when creating
documentation for several projects in the same output folder.
- create sub-folders to mirror the structure of the source project
- images files to be used for logo and copyright information to include as the
header and/or footer of each page
Order of Sections
This panel is used to select the sections to include in each document and the
order of the sections. Double click on a section to include / exclude it from the
documentation to be generated.
Output Format
This panel is used to set the default format to be used when generating the
documentation. The run-time setup panel is used to override most of these options. See Generate Documentation for additional
information.
The default format for the documentation is HTML. In fact, the other formats are
simply variations or repackaging of the HTML files.
Type of content to generate
- HTML
- Create one or more HTML files for the selected classes; the method used to
link between files is set on another option.
- Microsoft HTML Help (CHM)
-
Create a CHM (Microsoft Compressed HTML Help) file if the Microsoft HTML Help
Workshop compiler is available. These workshop files were available from the
Microsoft MSDN site - MSDN
HTML Help Download (June 2011).
- Mediawiki-compatible XML Export File
-
Create a Mediawiki
compatible XML export file to be used to import the generated documentation to an
existing Mediawiki site. The content that is created makes use of several Mediawiki
extensions to improve the formatting/usability:
- Custom Sidebar
-
This extension enables the dynamic sidebar functionality used for each of the major
documentation areas in the wiki. See the
web site for additional information.
- Tree View and Menu
-
This extension allows bullet lists to be rendered as folder trees or dynamic
drop-down menus. See the web
site for additional information.
|
When generating a Mediawiki-compatible export file, the size of the file(s)
will be limited to approximately 400KB. A separate export file is created for the
parent page and navigation sidebar content. |
HTML: Number of files to create
- Single file
- this format can be useful when sending documentation via email and a CHM file
cannot be created or is not acceptable.
- Separate file for each class
- This is the default output format; it will be forced when generating content
for one of the other formats
HTML: Method used to link to other pages
- Direct link to page
- All references to pages, including on the main index page, are direct links to
the page using the anchor tag.
- JavaScript - menu and content in same page
- The page is defined as a 2 column layout using DIV tags. The left column is a
narrow column for the "navigation menu" while the right column occupies the remainder
of the browser window and is used to display content. JavaScript is used to
dynamically load the content into each of the layout regions.
- JavaScript - menu and content load in separate frames
- The page is defined as a 2 column layout using IFRAME tags. The left column is
a narrow column for the "navigation menu" while the right column occupies the
remainder of the browser window and is used to display content. JavaScript is used to
dynamically load the content into each of the layout regions
- Use folder structure for navigation menu
- The navigation menu will mirror the folder structure of the project.
CHM: Location of 'HTML Help Workshop' compiler
The CHM compiler from the 'HTML Help Workshop' is required to create a MS-Windows
compiled HTML Help file. These workshop files were available from the Microsoft MSDN
site - MSDN HTML Help Download (June 2011).
WIKI: Parent page for generated files
Enter the location to be used as the "parent page" for the generated content when
it is imported to the wiki site. An index (tree list) of the generated class
documentation will be created as the content for this page.