Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "LDT/Developer Area/Lua Comment Model"

< LDT
Line 1: Line 1:
This is the model of a comment block.
+
This is the model of a comment block. this is the result of parsing of a comment block
  
 
   commentblock
 
   commentblock

Revision as of 12:35, 2 February 2012

This is the model of a comment block. this is the result of parsing 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

Back to the top