summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBilal Alsharifi <bilal.alsharifi@gmail.com>2020-08-17 16:42:26 -0400
committerBilal Alsharifi <bilal.alsharifi@gmail.com>2020-08-17 16:42:26 -0400
commit61ecc36e07c31a9041791862c7d1e7c466e9a02e (patch)
treed739a0e5702e1107a852c1d3fc99dbd32bb949e8
parentc92ff5dbd99ff663c4a81ab95868bc8967ee7842 (diff)
downloadsdl_android-61ecc36e07c31a9041791862c7d1e7c466e9a02e.tar.gz
Generate correct JavaDoc for deprecated APIs
-rw-r--r--generator/templates/base_template.java9
-rw-r--r--generator/templates/enum_template.java6
-rw-r--r--generator/templates/function_template.java6
-rw-r--r--generator/templates/javadoc_return.java6
-rw-r--r--generator/templates/javadoc_template.java6
-rw-r--r--generator/templates/struct_template.java6
6 files changed, 30 insertions, 9 deletions
diff --git a/generator/templates/base_template.java b/generator/templates/base_template.java
index 2cd4f450d..d2bdd1a57 100644
--- a/generator/templates/base_template.java
+++ b/generator/templates/base_template.java
@@ -71,15 +71,16 @@ import {{i}};{{ '\n' if loop.last }}
{%- if description is defined and (see is defined or since is defined) %}
*
{%- endif %}
- {%- if deprecated is not none %}
+ {%- if deprecated is defined and deprecated is not none and since is defined and since is not none %}
+ * @deprecated in SmartDeviceLink {{since}}
+ {%- elif deprecated is defined and deprecated is not none %}
* @deprecated
+ {%- elif since is defined and since is not none %}
+ * @since SmartDeviceLink {{since}}
{%- endif %}
{%- if see is defined %}
* @see {{see}}
{%- endif %}
- {%- if since is defined %}
- * @since SmartDeviceLink {{since}}
- {%- endif %}
*/
{%- endif %}
{%- if deprecated is not none %}
diff --git a/generator/templates/enum_template.java b/generator/templates/enum_template.java
index 0d3f1fa26..aa4f09067 100644
--- a/generator/templates/enum_template.java
+++ b/generator/templates/enum_template.java
@@ -11,7 +11,11 @@ public enum {{class_name}} {
{%- if param.description is defined and (param.since is defined or param.see is defined) %}
*
{%- endif %}
- {%- if param.since is defined %}
+ {%- if param.deprecated is defined and param.deprecated is not none and param.since is defined and param.since is not none %}
+ * @deprecated in SmartDeviceLink {{param.since}}
+ {%- elif param.deprecated is defined and param.deprecated is not none %}
+ * @deprecated
+ {%- elif param.since is defined and param.since is not none %}
* @since SmartDeviceLink {{param.since}}
{%- endif %}
{%- if param.see is defined %}
diff --git a/generator/templates/function_template.java b/generator/templates/function_template.java
index f587a636d..db664b4d2 100644
--- a/generator/templates/function_template.java
+++ b/generator/templates/function_template.java
@@ -6,8 +6,12 @@
{%- if p.origin not in ('success', 'resultCode', 'info') or kind != "response" %}
{%- if p.see is defined or p.deprecated is not none %}
/**
- {%- if p.deprecated is not none %}
+ {%- if p.deprecated is defined and p.deprecated is not none and p.since is defined and p.since is not none %}
+ * @deprecated in SmartDeviceLink {{p.since}}
+ {%- elif p.deprecated is defined and p.deprecated is not none %}
* @deprecated
+ {%- elif p.since is defined and p.since is not none %}
+ * @since SmartDeviceLink {{p.since}}
{%- endif %}
{%- if p.see is defined %}
* @see {{p.see}}
diff --git a/generator/templates/javadoc_return.java b/generator/templates/javadoc_return.java
index e37a69b87..7cde495a0 100644
--- a/generator/templates/javadoc_return.java
+++ b/generator/templates/javadoc_return.java
@@ -11,6 +11,10 @@
{%- if p.values is defined and p.values %}
* {%- for k in p.values %}{{ ' {' if loop.first}}"{{k}}": {{p.values[k]}}{{ ', ' if not loop.last else '}'}}{%- endfor %}
{%- endif %}
- {%- if p.since is defined %}
+ {%- if p.deprecated is defined and p.deprecated is not none and p.since is defined and p.since is not none %}
+ * @deprecated in SmartDeviceLink {{p.since}}
+ {%- elif p.deprecated is defined and p.deprecated is not none %}
+ * @deprecated
+ {%- elif p.since is defined and p.since is not none %}
* @since SmartDeviceLink {{p.since}}
{%- endif %} \ No newline at end of file
diff --git a/generator/templates/javadoc_template.java b/generator/templates/javadoc_template.java
index 93d4e7740..72cabc94e 100644
--- a/generator/templates/javadoc_template.java
+++ b/generator/templates/javadoc_template.java
@@ -11,6 +11,10 @@
{%- if p.values is defined and p.values %}
* {%- for k in p.values %}{{ ' {' if loop.first}}"{{k}}": {{p.values[k]}}{{ ', ' if not loop.last else '}'}}{%- endfor %}
{%- endif %}
- {%- if p.since is defined %}
+ {%- if p.deprecated is defined and p.deprecated is not none and p.since is defined and p.since is not none %}
+ * @deprecated in SmartDeviceLink {{p.since}}
+ {%- elif p.deprecated is defined and p.deprecated is not none %}
+ * @deprecated
+ {%- elif p.since is defined and p.since is not none %}
* @since SmartDeviceLink {{p.since}}
{%- endif %} \ No newline at end of file
diff --git a/generator/templates/struct_template.java b/generator/templates/struct_template.java
index 6307509f8..285df3292 100644
--- a/generator/templates/struct_template.java
+++ b/generator/templates/struct_template.java
@@ -5,8 +5,12 @@
{%- for p in params %}
{%- if p.see is defined or p.deprecated is not none %}
/**
- {%- if p.deprecated is not none %}
+ {%- if p.deprecated is defined and p.deprecated is not none and p.since is defined and p.since is not none %}
+ * @deprecated in SmartDeviceLink {{p.since}}
+ {%- elif p.deprecated is defined and p.deprecated is not none %}
* @deprecated
+ {%- elif p.since is defined and p.since is not none %}
+ * @since SmartDeviceLink {{p.since}}
{%- endif %}
{%- if p.see is defined %}
* @see {{p.see}}