Make #include guard naming consistent

Change-Id: Ie13e8af0bb74ed290f811dcad64ad06c9d8cb4fa
Signed-off-by: Marc Schink <openocd-dev@marcschink.de>
Reviewed-on: http://openocd.zylin.com/2956
Tested-by: jenkins
Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
This commit is contained in:
Marc Schink
2015-09-21 21:07:46 +02:00
committed by Andreas Fritiofson
parent d0e763ac7e
commit d4b7cbff88
164 changed files with 544 additions and 463 deletions

View File

@@ -72,6 +72,25 @@ Finally, try to avoid lines of code that are longer than than 72-80 columns:
- use underline characters between consecutive words in identifiers
(e.g. @c more_than_one_word).
@section style_include_guards Include Guards
Every header file should have a unique include guard to prevent multiple
inclusion.
To guarantee uniqueness, an include guard should be based on the filename and
the full path in the project source tree.
For the header file src/helper/jim-nvp.h, the include guard would look like
this:
@code
#ifndef OPENOCD_HELPER_JIM_NVP_H
#define OPENOCD_HELPER_JIM_NVP_H
/* Your code here. */
#endif /* OPENOCD_HELPER_JIM_NVP_H */
@endcode
@section stylec99 C99 Rules
- inline functions