diff options
| author | Mike Holmes <mike.holmes@linaro.org> | 2015-07-08 13:23:49 -0400 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-07-15 13:54:48 +0300 |
| commit | c0be213fbb1beb147b288beacdb40272e1d5cf31 (patch) | |
| tree | a5127d03b50ea8d856c31dc754a2a240eaca67c1 /doc | |
| parent | 5501b3afba8ba8b9640a7579967d91f46e6f3e1c (diff) | |
doc: doxygen: Add Converter function guidelines
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 | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index f3f7799cb..c544afd60 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -100,6 +100,16 @@ Another case might be if a packet has a vlan flag set Where possible returned information should be an enum if it reflects a finite list of information. In general get apis drop the actual tag "get" in the function name. +@subsection converter Converter Functions +To maintain efficiency in fastpath code converter functions should expect correct inputs with undefined results otherwise. + +@code +static inline odp_foo_t _odp_foo_from_bar(odp_bar_t bar) +{ + return (odp_foo_t)bar; +} +@endcode + @subsection function_calls Function Calls ODP APIs typically have prototypes of the form: |