Parameters
Name | Type | Mode |
---|---|---|
p_comments_config | ms_syst_priv.comments_config_apiview | IN |
Generates API View comments as well as comments for any requested columns.
API Views are typically closely associated with specific Data Tables. While this function does not require Data Table to API View parity of columns, types, etc. it does assume that a substantial amount of Data Table to API View parity exists. Given this, the descriptive texts of the API View and its columns are extracted from the Data Table comments and applied to the API View. Additional information that is specific for the API View is then added using the configurations passed in the p_comments_config
parameter.
Parameters
p_comments_config
:: Required? True; Default: ( No Default )
A ms_syst_priv.comments_config_apiview
value which provides the configuration and texts from which to generate the API View documentation. See the documentation of that database type for more information.
Name | Type | Mode |
---|---|---|
p_comments_config | ms_syst_priv.comments_config_apiview | IN |