When compiling a documentation, the following messages appear in the progress dialog:
Warning: The dead link 'LLL' was found in 'MMM' member.
The documentation is generated.
This is not a fatal error. It appears every time the link is to be created to the target which does not exist in the resulting documentation. In this case, only text which is not a link is created.
There are several reasons why the target does not exist:
2.The link is correct but the target is not included in the documentation because:
oThe target type is unchecked in the Compiling options dialog. Remember that if the type is excluded (e.g. a class), its members (methods, properties) are automatically excluded as well, even when they are nor explicitly unchecked in the options.
oThe target is located in the file which is not selected in the File Compiling Options dialog.
oThe target is excluded by a regex filter.
oThe target is excluded by conditional compilation with <compilewhen> tag.
There are two reasons why the link is created:
1.It is explicitly defined in VSdocman comment by user using the relevant tags (<see>, <seealso>, ...)
2.It is created automatically. For example when VSdocman compiles some class, it automatically creates Methods list of the methods of this class. As described in point 2. above, there is a possibility that some method is not included in documentation. This is the most common reason for the warning.
3.It is used in a class diagram.
•Make sure that all explicit links in VSdocman comments are spelled correctly.
•Make sure that all targets of all links are included in the documentation:
oCheck Compile also non-commented members option in Compiling options dialog when the target is not commented with VSdocman comments or comment the target with VSdocman comments.
oCheck the type of the target in the options.
oSelect the file of the target in the options.
•Remember that all methods and properties are also potential targets of automatic Members links in their classes. Therefore, the previous point also applies to them.