Links
Within your documentation you can link to external addresses. The target of the link is specified by using a URI (Uniform Resource Identifier). The URI must be enclosed in normal quotes so that the XML library can process the string correctly. You must always insert links within a Description, Summary or Example. You can either insert links in the same line of text or place a line break before the link. To do this, use the "see" and "seealso" markups.
See
Use the <see> markup to create a link within a line of text.
Example
Normal form:
(*!<description> You can find more information on our homepage
<see uri="http://www.beckhoff.de/TE1030"> Beckhoff Homepage </see>
</description>*)
Abbreviated form:
//!@description You can find more information on our homepage @see uri=http://www.beckhoff.de/TE1030 Beckhoff Homepage
In the documentation it looks like this:
Seealso
Use the <seealso> markup to create a line break before a link, placing the link in a new text section.
Example
Normal form:
//!<description> You can find more information on our homepage <seealso uri="http://www.beckhoff.de/TE1030"> Beckhoff Homepage </seealso> </description>
Abbreviated form:
//! @description You can find more information on our homepage @seealso http://www.beckhoff.de/TE1030
In the documentation it looks like this:
