saveComponentProperty

saveComponentProperty(componentName:                String; 
                      componentPropertyName:        String; 
                      componentPropertyDescription: String);

The saveComponentProperty method of the JadeOpenAPIGenerator class sets the description of a component property to new values, using the parameters listed in the following table.

Parameter Description
componentName Name of the component that contains the property that is to be modified
componentPropertyName Name of the property of the component that is to be modified
componentPropertyDescription New value for the description of the specified property of the specified component in the specification

If the property had an existing description, it is overridden with the new value.

Use this method to provide documentation of your properties to readers of the specification.

2020.0.02 and higher