Merge pull request #1766 from smartdevicelink/bugfix/issue-1761-updat…

…ing-history-deprecated-documentation Fixed generator history/deprecated documentation
smartdevicelink · Sep 17, 2020 · d927360 · d927360
2 parents e4e153f + 82b2e77
commit d927360
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 15 deletions.
diff --git a/generator/templates/description.jinja2 b/generator/templates/description.jinja2
@@ -8,14 +8,17 @@
  {%- if description and ( since or history ) %}
  *
  {%- endif %}
- {%- if deprecated %}
- * @deprecated
+ {%- if deprecated is sameas true %}
+ * @deprecated in SmartDeviceLink {{ since }}
+ {%- elif history %}
+ * @added in SmartDeviceLink {{ history }}
+ {%- elif since is defined %}
+ {%- if since %}
+ * @added in SmartDeviceLink {{ since }}
  {%- endif %}
- {%- if history %}
- * @history SDL {{ history }}
  {%- endif %}
- {%- if since %}
- * @since SDL {{ since }}
+ {%- if deprecated is sameas true and history %}
+ * @added in SmartDeviceLink {{ history }}
  {%- endif %}
  */
 {%- endif -%}

diff --git a/generator/templates/description_param.jinja2 b/generator/templates/description_param.jinja2
@@ -8,14 +8,17 @@
  {%- if param.description and ( param.since or param.history ) %}
  *
  {%- endif %}
- {%- if param.deprecated %}
- * @deprecated
+ {%- if param.deprecated is sameas true %}
+ * @deprecated in SmartDeviceLink {{ param.since }}
+ {%- elif param.history %}
+ * @added in SmartDeviceLink {{ param.history[0].since }}
+ {%- elif param.since is defined %}
+ {%- if param.since %}
+ * @added in SmartDeviceLink {{ param.since }}
  {%- endif %}
- {%- if param.history %}
- * @history SDL {{ param.history }}
  {%- endif %}
- {%- if param.since %}
- * @since SDL {{ param.since }}
+ {%- if param.deprecated is sameas true and param.history %}
+ * @added in SmartDeviceLink {{ param.history[0].since }}
  {%- endif %}
  */
 {%- endif %}
diff --git a/generator/transformers/common_producer.py b/generator/transformers/common_producer.py
@@ -30,7 +30,7 @@ def __init__(self, enum_names=(), struct_names=(), key_words=()):
         self.key_words = key_words
         self.param_named = namedtuple('param_named',
                                       'origin constructor_argument constructor_prefix deprecated mandatory since '
-                                      'method_suffix of_class type_native type_sdl modifier for_name description '
+                                      'method_suffix of_class type_native type_sdl modifier for_name description history '
                                       'constructor_argument_override')
         self.constructor_named = namedtuple('constructor', 'init self arguments all')
         self.argument_named = namedtuple('argument', 'origin constructor_argument variable deprecated')
@@ -336,7 +336,8 @@ def extract_param(self, param: Param, item_name: str):
                 'since': param.since,
                 'mandatory': param.is_mandatory,
                 'deprecated': json.loads(param.deprecated.lower()) if param.deprecated else False,
-                'modifier': 'strong'}
+                'modifier': 'strong',
+                'history' : param.history }
         if isinstance(param.param_type, (Integer, Float, String, Array)):
             data['description'].append(self.create_param_descriptor(param.param_type, OrderedDict()))
 

diff --git a/generator/transformers/enums_producer.py b/generator/transformers/enums_producer.py
@@ -21,7 +21,7 @@ def __init__(self, enum_class, key_words):
         self._container_name = 'elements'
         self.enum_class = enum_class
         self.logger = logging.getLogger(self.__class__.__name__)
-        self.param_named = namedtuple('param_named', 'origin description name since deprecated')
+        self.param_named = namedtuple('param_named', 'origin description name since deprecated history')
         self._item_name = None
 
     @property
@@ -45,6 +45,7 @@ def transform(self, item: Enum, render: dict = None) -> dict:
             render['origin'] = item.name
             render['name'] = name
             render['imports'] = imports
+            render['history'] = item.history
         super(EnumsProducer, self).transform(item, render)
         return render
 
@@ -58,6 +59,7 @@ def extract_param(self, param: EnumElement, item_name: str):
         data = {'origin': param.name,
                 'description': self.extract_description(param.description),
                 'since': param.since,
+                'history': param.history,
                 'deprecated': json.loads(param.deprecated.lower()) if param.deprecated else False}
         name = None
         if re.match(r'^[A-Z]{1,2}\d|\d[A-Z]{1,2}$', param.name):

diff --git a/generator/transformers/functions_producer.py b/generator/transformers/functions_producer.py
@@ -58,6 +58,7 @@ def transform(self, item: Function, render: dict = None) -> dict:
             render['name'] = name
             render['extends_class'] = extends_class
             render['imports'] = imports
+            render['history'] = item.history
 
         super(FunctionsProducer, self).transform(item, render)
 

diff --git a/generator/transformers/structs_producer.py b/generator/transformers/structs_producer.py
@@ -42,6 +42,7 @@ def transform(self, item: Struct, render: dict = None) -> dict:
             render['name'] = name
             render['extends_class'] = self.struct_class
             render['imports'] = imports
+            render['history'] = item.history
 
         super(StructsProducer, self).transform(item, render)