Skip to main content

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.

Jump to: navigation, search

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

< LDT
 
(8 intermediate revisions by the same user not shown)
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.
 +
(see the module which parses it : [http://git.eclipse.org/c/ldt/org.eclipse.ldt.git/tree/libraries/modelsbuilder/models/ldparser.lua ldparser.lua], the code is based on lua and metalua)
  
 
   commentblock
 
   commentblock
 
   .string shortdescription
 
   .string shortdescription
 
   .string description
 
   .string description
   .(list(tag) tagname)
+
   .map(tagname -> list(tag)) tags
 +
  .map(tagname -> list(tag)) unknowntags
 +
 
  
 
   tag= module | type | function | return | field | param
 
   tag= module | type | function | return | field | param

Latest revision as of 04:00, 17 July 2014

This is the model of a comment block. this is the result of parsing of a comment block. (see the module which parses it : ldparser.lua, the code is based on lua and metalua)

 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

Back to the top