On 11/26/2014 10:13 PM, Mike Holmes wrote: > Signed-off-by: Mike Holmes <mike.hol...@linaro.org> > --- > api_guide_lines.dox | 6 ++++++ > 1 file changed, 6 insertions(+) > > diff --git a/api_guide_lines.dox b/api_guide_lines.dox > index be23e9a..1f83c53 100644 > --- a/api_guide_lines.dox > +++ b/api_guide_lines.dox > @@ -144,6 +144,12 @@ The values !0 = true, 0 = false are used for this > purpose. > Pass indications are integers (int) and SHOULD also be used for APIs that > return a simple success/failure indication to the caller. > In this case the return value 0 indicates success while non-zero (typically > -1) indicates failure and errno is set to a reason code that indicates the > nature of the failure. > > +@subsection odp_internal Internal APIs > +When an interface is defined in a header file and is intended to to be > reused internally it will follow these rules:- > +- Be prefixed with an underscore "_". > +- It may not be placed in include/api.
Is this item necessary? I have some internal APIs that are used by ODP API which implemented as 'static inline' functions directly in API headers. These internal APIs have to be placed in include/api. > +- All the required definitions for the API are to use an underscore, this > includes MACROS, typedefs, enums and function names. > + > @section implementation Implementation Considerations > To support application portability and preserve implementation flexibility, > ODP APIs MUST be designed with several guiding principles in mind. > > -- Taras Kondratiuk _______________________________________________ lng-odp mailing list lng-odp@lists.linaro.org http://lists.linaro.org/mailman/listinfo/lng-odp
