guard

Syntax


[#guard]condition[/#guard]

where:

Description

The guard tag conditionally skips the evaluation of a doc template.

If the guard fails (the condition evaluate to false), the body of the doc template is ignored and the generated file is not written on disk.

Examples

This will generate a simple documentation for a UML class, only if it is not abstract:

[#parameters]in model : uml21[/#parameters]
[#file]output.xml[/#file]
[#set]class = model.getInstances(“Class”).first()[/#set]
[#guard]! class.isAbstract[/#guard]
Class: ${class.name}
...