Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
LDT/Developer Area/Lua Comment Model
< LDT
Revision as of 05:04, 12 September 2012 by Unnamed Poltroon (Talk) (Koneki/LDT/Technical Documentation/Lua Comment Model moved to Koneki/LDT/Developer Area/Lua Comment Model)
This is the model of a comment block. this is the result of parsing of a comment block
commentblock .string shortdescription .string description .map(tagname -> list(tag)) tags .map(tagname -> list(tag)) unknowntags
tag= module | type | function | return | field | param
module .string tag='file' .string name
type .string tag='type' .string name
function .string tag='function' .string parent = typename or #global .string name
return .string tag='return' .list(typeref) types .string description
field .string tag='field' .string name .string parent = typename or #global .string description .typeref type
param .string tag='param' .string name .string description .typeref type
typeref .module .type