[MDSAL-166] Wrong placement of deprecated annotation

Fri, 9 Mar 2018 18:00:15 +0000

There are 3 misplacements:

we have unexpected javadoc annotation inside of yang model citation
we miss java and javadoc annotations for leaves
we miss correctly placed javadoc annotation

Yang citation in javadoc shall not contain any annotations.
In case of leaf the only available place for both annotations is above getter.
In case of sub-container - both annotations can be placed above corresponding getter in parent structure or inside the container's interface.

consider this yang fragment:
list my-list {
key ip-prefix;
leaf ip-prefix

{ type inet:ip-prefix; }

leaf l3-context

{ status deprecated; type gbp-common:context-id; mandatory true; }

container network-containment

{ status deprecated; uses some-grouping; }

}

Then the top level interface has following javadoc (containing 2 unexpected @deprecated annotations):
...

<pre>
list my-list {
key "ip-prefix"
leaf ip-prefix { * type ip-prefix; * }
@deprecated - status DEPRECATED
leaf l3-context { * type context-id; * status DEPRECATED; * }
@deprecated - status DEPRECATED
container network-containment { * .. items from grouping * uses network-domain-key; * status DEPRECATED; * }
}
</pre>
...

Generated getters look like this (no java nor javadoc annotations):
/**

The context for the endpoint's layer 3 address
*
*/
ContextId getL3Context();

/**

The network domain associated with this endpoint's fowarding context.
*
*/
NetworkContainment getNetworkContainment();

And NetworkContainment javadoc looks following (unexpected javadoc annotation and correct java annotation below):

<pre>
@deprecated - status DEPRECATED
container network-containment { * .. items from grouping * uses network-domain-key; * status DEPRECATED; * }
</pre>
*...
*/
@Deprecated

OpenDaylight JIRA

[MDSAL-166] Wrong placement of deprecated annotation