diff options
| author | NicoleYarroch <nicole@livio.io> | 2020-10-27 14:41:48 -0400 |
|---|---|---|
| committer | NicoleYarroch <nicole@livio.io> | 2020-10-27 14:41:48 -0400 |
| commit | 6ed231c2345e8eacdeebe2e568d34f44cbc987bb (patch) | |
| tree | c34a4ac64aadbde3deee793b56ba15d1decc3a7f | |
| parent | 0a25891249cc10fa9e008b24663abee2648f14db (diff) | |
| download | sdl_ios-6ed231c2345e8eacdeebe2e568d34f44cbc987bb.tar.gz | |
Updating documentation for methods
Signed-off-by: NicoleYarroch <nicole@livio.io>
| -rw-r--r-- | generator/transformers/common_producer.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/generator/transformers/common_producer.py b/generator/transformers/common_producer.py index 84100facd..fd5d4cf74 100644 --- a/generator/transformers/common_producer.py +++ b/generator/transformers/common_producer.py @@ -382,7 +382,7 @@ class InterfaceProducerCommon(ABC): def create_param_type_descriptor(self, param_type, parameterItems): """ - Gets all the descriptors for a parameter (e.g. {"string_min_length": 1, string_max_length": 500}). The parameters should be returned in the same order they were added to the parameterItems dictionary + Gets all the descriptors for a parameter to be used in parameter's documentation (e.g. {"string_min_length": 1, string_max_length": 500}). The parameters should be returned in the same order they were added to the parameterItems dictionary :param param_type: param_type from the initial Model :param parameterItems: Ordered dictionary that stores each of the parameter's descriptors :return: All the descriptor params @@ -408,7 +408,7 @@ class InterfaceProducerCommon(ABC): def create_param_default_value_descriptor(self, param, parameterItems): """ - Creates a documentation string of the default value for a parameter from the param. (HAX: The default_value for Enums and Bools are not saved to the param's param_type model for some reason) + Extracts the default value for a parameter to be used in parameter's documentation (HAX: The default_value for Ints and Floats is save to both the param and param_type but is only saved to the param_type for Enums and Bools for some reason) :param param: param from the initial Model :param parameterItems: Ordered dictionary that stores each of the parameter's descriptors :return: All the descriptor params |