Start VSdocman Comment Editor, uncheck WYSIWYG button and select References tab.

This dialog allows to edit all references that may appear in the member's documentation. User is not required to know the link syntax, target members may be selected by dialog.

See Also

Edit See also links. Corresponds to <seealso> tag. Use Add and Remove buttons to add new link or delete selected one from the list on the left.

Link

The target of the link as specified in <seealso> syntax. There's a button that invokes Select reference dialog. User can select the target from the list, whether the member in the project or external file.

Label

Link label shown in documentation. See the <seealso> syntax.

Find interesting references

This button brings some intelligence to the comment editor. When you press it, editor automatically shows a list of suggested links that might appear in See Also section. You can then select which are to be inserted. VSdocman looks for implemented interfaces or interface implementing classes, argument types of current method or types used inside current method.

 

Exceptions

Edit Exceptions table. Corresponds to <exception> tag. Use Add and Remove buttons to add new link or delete selected one from the list on the left.

Link

The the link to exception as specified in <exception> syntax. There's a button that invokes Select reference dialog. User can select the target from the list.

Description

Description of exception. See the <exception> syntax.

 

See Also