| Message ID | 1429722779-24130-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Accepted |
| Commit | ee2eba6f231830539ca6d571d9cb8ba159c7518b |
| Headers | show |
On Wed, Apr 22, 2015 at 12:12 PM, Mike Holmes <mike.holmes@linaro.org> wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org> > --- > v2 add doxygen description > > doc/api_guide_lines.dox | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox > index 2bc63a1..0832cae 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. > > -- > 2.1.0 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index 2bc63a1..0832cae 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.
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- v2 add doxygen description doc/api_guide_lines.dox | 5 +++++ 1 file changed, 5 insertions(+)