The Documenter controls are used while defining and building the automated source documentation produced for Doc-To-Help. These controls are located at the top of the Documenter user interface. To learn more about these controls, see Documenter for .NET Guided Tour.
|
|
New Project |
Start a new Documenter project. |
|
|
Open Project |
Open an existing Documenter project. |
|
|
Project Files |
View and edit the assembly and XML files for the current project. |
|
|
Project Options |
View and edit project options including generated syntax, including/excluding elements and generating additional links. |
|
|
Generate New Document |
Generate a new Documenter source document. |
|
|
Regenerate Existing Document |
Regenerate an existing Documenter source document. For information on regenerating a document, see "A Note About Regeneration" in the Updating the Assembly and the Documentation topic. |
|
|
View Document |
View the current Documenter source document. |
|
|
Document Changes in Last Generation |
View a document showing the changes from the last document generation. |
|
|
Backup Document |
Backup your current source document (before regeneration). |
|
|
Document Backup Versions |
View the document backup versions. |
|
|
Show Lost Changes in Last Generation |
View previously made changes that did not appear in the last document generation. |
Some of the controls above also appear on Documenter's menu bar, along with additional controls:
File
|
New |
Start a new Documenter project. |
|
Open |
Open an existing Documenter project. |
|
Close |
Close the current Documenter project. |
|
Recent Projects |
List projects that have recently been open. |
|
Exit |
Exit Documenter. |
View
|
Open Generated Document |
Open the generated document. |
|
Document Changes in Last Generation |
View a document showing the changes from the last document generation. |
|
Document Backup Versions |
View the document backup versions. |
|
Lost Change in Last Generation |
View previously made changes that did not appear in the last document generation. |
Project
|
Files |
View and edit the assembly and XML files for the current project. |
|
Options |
View and edit project options including generated syntax, including/excluding elements and generating additional links. |
Generate
|
Generate New Document |
Generate a new Documenter source document. |
|
Regenerate Existing Document |
Regenerate an existing Documenter source document. For information on regenerating a document, see "A Note About Regeneration" in the Updating the Assembly and the Documentation topic. |
|
Backup Document |
Backup your current source document (before regeneration). |
Tool
|
List Elements Without Description |
Lists assembly elements included in the element tree that do not have description neither in the assembly itself (Description attribute) nor in the XML comments. This may be intentional, in which case you probably do not want include those elements in the generated document. To make sure they do not appear in the generated document, check the Exclude elements without description check box in the Project|Options dialog. Some elements may be missing description by mistake. Listing them using this menu item helps you to detect such mistakes. |
|
View Incorrect User Changes |
Opens the document and allows you to see incorrect changes you did in the document. After the document is generated by Documenter, you can make changes to it and they will be preserved when Documenter regenerates the document if those changes satisfy the rule: you can add and remove paragraphs but you should not make changes to the automatically generated paragraphs. This menu item allows you to check that your changes do not break this rule. You can navigate through incorrect changes using a special Incorrect Change toolbar with Next and Previous buttons. |
|
View Invalid XML Comments |
Shows unsupported tags in the XML comment file. |