Parameters
Name | Type | Mode |
---|---|---|
p_comments_config | ms_syst_priv.comments_config_function | IN |
Generates comments for functions, procedures, and trigger functions.
Parameters
p_comments_config
:: Required? True; Default: ( No Default )
A configuration object of type ms_syst_priv.comments_config_function
which is used in automatically generating the appropriately formatted function comments.
General Usage
If the default value of a documented function is longer than ~40 characters, it may be better to set the default_value
to refer to the “General Usage” section and then explain the default value there. This due to line-length issues in the resulting formatted comments.
Name | Type | Mode |
---|---|---|
p_comments_config | ms_syst_priv.comments_config_function | IN |