beckhoff TE1030 TwinCAT 3 — 7.2 Delimiters

Markups 7.2 Delimiters To generate the documentation, delimiters must be inserted in the comments. These delimiters work in combination with the markups. For examples of how to use the delimiters, see the examples for each markup. The following delimiters are allowed: TE1030 17 Version: 1.3.3 Normal form Abbreviated form Context Description @description Text section marked as description. @summary Text section marked as summary. @example Text section formatted as an example. - - description, summary, example Headings up to level 6 @code description, summary, example Section with source code @literal description, summary, example Plain text that is not to be interpreted.

- $crossreference description, summary, example Cross-reference @see description, summary, example Link within a section of text @seealso description, summary, example Link outside any text section @param Parameter value @ul description, summary, example Defines an unordered list. @ol description, summary, example Defines a numbered list. - description, summary, example Element of a list - description, summary, example Defines a table similar to HTML. - description, summary, example Creates a table with header. - description, summary, example Creates a table row. - description, summary, example Creates a table column. - Defines a user group for the selected text section.

@preliminary Marks a section as needing to be changed. - description, summary, example Defines safety instructions (Danger, Warning, Note). - description, summary, example Includes an image. //! Single-line documentation comment (*! …*) Multi-line documentation comment