diff options
| author | Mike Holmes <mike.holmes@linaro.org> | 2015-03-17 14:57:19 -0400 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-03-30 17:18:27 +0300 |
| commit | eb57f2738d62858b12d23136ad65758c35c0fcae (patch) | |
| tree | d32464d237c27e4273517ca499911e902186c163 /doc | |
| parent | c05f2a32659975b3f72a4781ca6755f8b7f9cecb (diff) | |
doc: doxygen: add declaring variables
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 | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/api_guide_lines.dox b/doc/api_guide_lines.dox index 4cfe0889d..2bc63a107 100644 --- a/doc/api_guide_lines.dox +++ b/doc/api_guide_lines.dox @@ -149,6 +149,21 @@ When an interface is defined in a header file and is intended to to be reused in - Be prefixed with an underscore "_". - All the required definitions for the API are to use an underscore, this includes MACROS, typedefs, enums and function names. +@subsection variables Declaring variables +- Variables shall be declared at the begining of scope, for example :- +@code + int start_of_global_scope; + + main () { + int start_of_function_scope; + ... + if (foo == bar) { + int start_of_block_scope; + ... + } + } +@endcode + @section implementation Implementation Considerations To support application portability and preserve implementation flexibility, ODP APIs MUST be designed with several guiding principles in mind. |