parameters

Syntax

[#parameters]parameters[/#parameters]

where:


Each parameter is of the form:

direction name : type

where:

Description

The parameters tag defines the signature of a doc template

The template may define expected parameters, used to compute the generated contents. Any caller of the template must provide matching arguments. A template is usually used to produce a document based on model elements that won't be modified during the generation. So most of the time, the direction in will be used to define a model parameter, although you're free to use out and inout.

The template contents usually starts with a file tag, which defines the name of the file where the generated text will be written.

Examples

This will generate a simple documentation of a UML 2.1 model:

[#parameters]in model : uml21[/#parameters]
[#file]generated/output.xml[/#file]
UML model documentation
[#foreach class in model.getInstances("Class")]
    Class: ${class.name}
[/#foreach]

Related concepts
Doc template