diff options
Diffstat (limited to 'docs/contributor_guide/contribution_guidelines.dox')
| -rw-r--r-- | docs/contributor_guide/contribution_guidelines.dox | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/contributor_guide/contribution_guidelines.dox b/docs/contributor_guide/contribution_guidelines.dox index d0287341b4..30ee41af0f 100644 --- a/docs/contributor_guide/contribution_guidelines.dox +++ b/docs/contributor_guide/contribution_guidelines.dox @@ -1,5 +1,5 @@ /// -/// Copyright (c) 2019-2022 Arm Limited. +/// Copyright (c) 2019-2023 Arm Limited. /// /// SPDX-License-Identifier: MIT /// @@ -240,6 +240,18 @@ class ClassName }; @endcode +- In header files, use header guards that use the full file path from the project root and prepend it with "ACL_" + +@code{cpp} +// For File arm_compute/runtime/NEON/functions/NEBatchNormalizationLayer.h +#ifndef ACL_ARM_COMPUTE_RUNTIME_NEON_FUNCTIONS_NEBATCHNORMALIZATIONLAYER +#define ACL_ARM_COMPUTE_RUNTIME_NEON_FUNCTIONS_NEBATCHNORMALIZATIONLAYER +. +. +. +#endif /* ACL_ARM_COMPUTE_RUNTIME_NEON_FUNCTIONS_NEBATCHNORMALIZATIONLAYER */ +@endcode + - Use quotes instead of angular brackets to include local headers. Use angular brackets for system headers. - Also include the module header first, then local headers, and lastly system headers. All groups should be separated by a blank line and sorted lexicographically within each group. - Where applicable the C++ version of system headers has to be included, e.g. cstddef instead of stddef.h. |