Introduce what the command does. Ideally, the introduction should be short, as in the following typical example:
Starts WebLogic Server in a specific domain.
CommandName [argument1] argument2 |syntax| |syntaxpartname|
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.
If there are no arguments, write:
None.
Actual argument lists resemble the following:
argument1 |partname|
Optional. Disables logging, which my increase performance depending on logging configuration. Default: logging is enabled. |partdesc|
argument2 |partname|
Required. Specifies that both WebLogic Workshop and WebLogic Server should be run in production mode. Default: development mode. |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.
startWebLogic Command