Annotation Interface Example
An example of using a function that is rendered in the docs.
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionIf the example is applicable to only a capability available in a specific versionThe description that will appear before the exampleThe explanation that will appear after the example.
-
Element Details
-
description
String descriptionThe description that will appear before the example- Default:
""
-
file
String fileThe test file that contains the example. -
tag
String tagThe tag that fences this example. -
applies_to
String applies_toIf the example is applicable to only a capability available in a specific version- Default:
""
-
explanation
String explanationThe explanation that will appear after the example.- Default:
""
-