Cross references

To create a reference to another element within the documentation, use the "$" character. If the reference target is not within the same code element, a qualified name, i.e. a full domain name, must be used. TwinCAT Documentation Generation automatically searches for this element and creates a hyperlink in the documentation. You use the cross-reference within the Description, Summary and Example markups.

Example

Normal form:

//!<description> You can find an example in $Codeblock </description>

Abbreviated form:

//!@description You can find an example in $Codeblock