Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "LDT/Developer Area/Lua Comment Model"
< LDT
(New page: This is the model of a comment block. commentblock .string shortdescription .string description .list(maintag) maintag .(list(tag) tagname) maintag=file | recordtype | functi...) |
|||
| Line 4: | Line 4: | ||
.string shortdescription | .string shortdescription | ||
.string description | .string description | ||
| − | |||
.(list(tag) tagname) | .(list(tag) tagname) | ||
| − | + | tag= module | type | function | return | field | param | |
| − | + | module | |
| − | .string | + | .string tag='file' |
| + | .string name | ||
| − | + | type | |
| − | .string | + | .string tag='type' |
.string name | .string name | ||
function | function | ||
| − | .string | + | .string tag='function' |
| − | + | .string parent = typename or #global | |
| − | .string | + | |
.string name | .string name | ||
| − | |||
| − | |||
return | return | ||
| + | .string tag='return' | ||
.list(typeref) types | .list(typeref) types | ||
.string description | .string description | ||
field | field | ||
| + | .string tag='field' | ||
.string name | .string name | ||
| + | .string parent = typename or #global | ||
.string description | .string description | ||
.typeref type | .typeref type | ||
param | param | ||
| + | .string tag='param' | ||
.string name | .string name | ||
.string description | .string description | ||
Revision as of 12:35, 2 February 2012
This is the model of a comment block.
commentblock .string shortdescription .string description .(list(tag) tagname)
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