| Message ID | 1436550599-23287-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | New |
| Headers | show |
On Fri, Jul 10, 2015 at 12:49 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> > --- > doc/api_guide_lines.dox | 11 +++++++++++ > 1 file changed, 11 insertions(+) > > diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox > index f3f7799..70d6cb8 100644 > --- a/doc/api_guide_lines.dox > +++ b/doc/api_guide_lines.dox > @@ -78,6 +78,17 @@ Other mechanisms available to the implementer are: > - ODP_DEPRECATED() is used to signify that a call is planned for > obsolescence. > - ODP_LOG() is used to direct implementation messages to the application. > > +@subsection structure Structure Initialization > +For each structure defined in the ODP API an initialization function is > required. > +It must take the form odp<structure_name>_init for example:- > + > +@code > +typedef struct odp_foo_t { > +... > +} odp_foo_t > + > +void odp_foo_init(odp_foo_t *foo); > +@endcode > > @subsection function_name Function Names > Functions must attempt to be so clear in their intent that referencing > the documentation is not necessary, the guidelines below should be followed > unless a strong case is made for an exception. > -- > 2.1.4 > > _______________________________________________ > lng-odp mailing list > lng-odp@lists.linaro.org > https://lists.linaro.org/mailman/listinfo/lng-odp >
On 07/10/15 20:49, Mike Holmes wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > --- > doc/api_guide_lines.dox | 11 +++++++++++ > 1 file changed, 11 insertions(+) > > diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox > index f3f7799..70d6cb8 100644 > --- a/doc/api_guide_lines.dox > +++ b/doc/api_guide_lines.dox > @@ -78,6 +78,17 @@ Other mechanisms available to the implementer are: > - ODP_DEPRECATED() is used to signify that a call is planned for obsolescence. > - ODP_LOG() is used to direct implementation messages to the application. > > +@subsection structure Structure Initialization > +For each structure defined in the ODP API an initialization function is required. > +It must take the form odp<structure_name>_init for example:- 1. odp_<structure_name>_init. (_ after odp is missing). 2. please check after example ":-". Should it be ":" ? Maxim. > + > +@code > +typedef struct odp_foo_t { > +... > +} odp_foo_t > + > +void odp_foo_init(odp_foo_t *foo); > +@endcode > > @subsection function_name Function Names > Functions must attempt to be so clear in their intent that referencing the documentation is not necessary, the guidelines below should be followed unless a strong case is made for an exception.
diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index f3f7799..70d6cb8 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -78,6 +78,17 @@ Other mechanisms available to the implementer are: - ODP_DEPRECATED() is used to signify that a call is planned for obsolescence. - ODP_LOG() is used to direct implementation messages to the application. +@subsection structure Structure Initialization +For each structure defined in the ODP API an initialization function is required. +It must take the form odp<structure_name>_init for example:- + +@code +typedef struct odp_foo_t { +... +} odp_foo_t + +void odp_foo_init(odp_foo_t *foo); +@endcode @subsection function_name Function Names Functions must attempt to be so clear in their intent that referencing the documentation is not necessary, the guidelines below should be followed unless a strong case is made for an exception.
Signed-off-by: Mike Holmes <mike.holmes@linaro.org> --- doc/api_guide_lines.dox | 11 +++++++++++ 1 file changed, 11 insertions(+)