diff options
| author | Mike Holmes <mike.holmes@linaro.org> | 2015-04-22 13:12:59 -0400 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-04-23 11:45:22 +0300 |
| commit | 0cbd93fa20d1e0b8f0fc0a9fdd4dc556aedd2fb4 (patch) | |
| tree | 80314ee17b34e3e356230e94708b1d2c9ff29181 /doc | |
| parent | 64fd29e46803a0a391d3abcc68ea3d1c99ecf994 (diff) | |
doc: api_guide_lines: add guidance on ODP_DEPRECATED
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api_guide_lines.dox | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index 2bc63a107..0832caea0 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -187,6 +187,11 @@ This is one of the reasons why some features MAY be defined as OPTIONAL. While allowed, the proliferation of OPTIONAL features SHOULD be avoided to enable broad application portability across many implementations. At the same time, a “least common denominator” approach MUST NOT be taken as that defeats the purpose of providing higher-level abstractions in APIs. +@subsection odp_deprecated ODP DEPRECATED +A deprecated API will remain marked as such in the public API using #ODP_DEPRECATED for two release cycles for the #ODP_VERSION_API_MAJOR number. +For example an API marked as deprecated in 1.1.0 will still be present in 1.2.0 and removed in 1.3.0. +A deprecated API will contain the doxygen tag \@deprecated with a description of the reason for the change. + @section defaults Default behaviours When an API has a default behaviour it must be possible for the application to explicitly call for that behaviour, this guards against the default changing and breaking the application. |