Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Documentation blocks (implementation pending)

Types (FB, PRG, ENUMS, etc) and their members can be documented at PLC side and Ixnton helps you to transfer documentation content to the emitted code.
Types (FB, PRG, ENUMS, etc) and their members can be documented at PLC side and Inxton helps you to transfer documentation content to the emitted code.

Transferable documentations comments must be enclosed with syntax as indicated in the following example. In addition to that the documentation content mus be placed between documentation tags. Content placed within the documentation tags will then be placed as documentation comments to the emitted code.
Transferable documentations comments must be enclosed with syntax as indicated in the following example. In addition to that the documentation content must be placed between documentation tags. Content placed within the documentation tags will then be placed as documentation comments to the emitted code.

>NOTE: There is no syntax checking and the content is transferred 'as is'.

Expand Down Expand Up @@ -37,4 +37,4 @@ public class fbDocumentedBlock
/// <summary>this is a member that is documented.</summary>
/// <note> this is note to documented member</note>
...boolean documentedMember {get; set;}
}
}