Audience
With this markup you can define that parts of the documentation are generated only for a defined user group. The markup must be included in a Description, Summary or Example.
The desired target group must be defined in two places.
On the one hand, it must be set during the configuration of the documentation.
- 1. To do this, select either "general" or "internal" from the drop-down menu Audience.
On the other hand, the target group must be specified as "audience type" within the markup.
Example
Normal form:
(*!<description>This is a normal part of the documentation.
<audience type="internal">This part is displayed for internal use only.
</audience></ description>*)
If the target group has been set in both places, the documentation will be output accordingly. Currently, the two target groups "general" and "internal" are available. If you set the target group to "internal", the text within the markup will not be output to the documentation.