Providing short description text

Every pattern and parameter includes a Short Description property to briefly describe the use or purpose of the pattern or parameter. You can provide a short description when adding the new patterns and parameters to the pattern library. Short descriptions can also be added or modified in the Properties view.

About this task

The short description is displayed for the pattern applier on the Short Description page of the Pattern Explorer view and the generated help documentation. The parameter short description also appears in two additional locations: in the parameter windows used to specify arguments for the parameters and in the tooltip text on the diagram view when the user hovers over the parameter in the pattern instance.

Procedure

In the Pattern Authoring view, right-click a pattern or a parameter and click Show Properties View.
In the Properties view, click the Value cell for the Short Description property and type the information you want to add.

Feedback