Begin with no more than a phrase or two describing the tag. A typical introduction might resemble the following:
Specifies the role a method or callback plays in a service's conversations. Note that these roles are different between methods and callbacks.
@identifier:tag |syntax|
[property1="propertyValue1"] |syntaxindent|
property2="propertyValue2" |syntaxindent|
List all of the arguments you included in the Syntax section. For each, indicate whether it's required or optional, specify its possible values, and indicate the default when applicable. Include as much information as is necessary. For most arguments, a sentence is enough, though there are legitimate exceptions. Actual argument descriptions resemble the following:
property1 |attribute|
Optional. Specifies the name of the JMS header or property field from which the WebLogic Workshop conversation ID is read in incoming messages. If not specified, the default is JmsControl.HEADER_CORRELATIONID. See remarks below. |partdesc|
property2 |attribute|
Required. Specifies an XML document fragment (an XML map), optionally containing substitution tokens enclosed in curly braces ("{}"). The XML map must be delimited by "::" and must include <header> as the outermost element.
No default. |partdesc|
The information you provide in the remarks section can be extensive. Include any information you think the developer will need or can use to implement the event or callback. This might include code samples, usage guidelines, and tips for implementation.
[tbd]