Audience

Mit diesem Markup können Sie definieren, dass Teile der Dokumentation nur für eine definierte Benutzergruppe generiert werden. Das Markup muss in eine Description, Summary oder ein Example eingebunden werden.

Die gewünschte Zielgruppe muss an zwei Stellen definiert werden.

Zum einen muss sie bei der Konfiguration der Dokumentation eingestellt werden.

1. Wählen Sie dafür im Drop-down-Menü Audience entweder „general“ oder „internal“ aus.
Audience 1:

Zum anderen muss die Zielgruppe innerhalb des Markups als „audience type“ angegeben werden.

Beispiel

Normalform:

(*!<description>Dieses ist ein normaler Teil der Dokumentation.
<audience type="internal">Dieser Teil wird nur für den internen Gebrauch angezeigt.</audience></ description >*)

Wenn die Zielgruppe an beiden Stellen eingestellt wurde, wird die Dokumentation entsprechend ausgegeben. Derzeit sind die beiden Zielgruppen “general” und “internal” verfügbar. Wenn Sie die Zielgruppe “internal” einstellen, wird der Text innerhalb des Markups nicht in die Dokumentation ausgegeben.