From ac8a3c40a8f1fa1b1149da5234b226e4ab129589 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Wed, 5 Jun 2019 16:18:45 -0600 Subject: [PATCH] Documentation/NuttXCCodingStandard.html: A few more additions to the previous commit. --- Documentation/NuttXCCodingStandard.html | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/Documentation/NuttXCCodingStandard.html b/Documentation/NuttXCCodingStandard.html index db301816fd..27d5473746 100644 --- a/Documentation/NuttXCCodingStandard.html +++ b/Documentation/NuttXCCodingStandard.html @@ -260,7 +260,7 @@

Forming Guard Names. Then pre-processor macro name used in the guard is formed from the full, relative path to the header for from the top-level, controlled directory. - That pat is preceded by __ and _ replaces each character that would otherwise be invalid in a macro name. + That path is preceded by __ and _ replaces each character that would otherwise be invalid in a macro name. So, for example, __INCLUDE_NUTTX_ARCH_H corresponds to the header file include/nuttx/arch.h

@@ -2799,6 +2799,7 @@ error:
Global variables and singletons begin with an upper case 'G'. For example, GMyGlobalVariable. + The prefix g_ is never used.
Implementation Class Names @@ -2822,12 +2823,21 @@ error: Template classes begin with an upper case 'T'. For example, TMyTemplate. +
+ typedef'd Type Names +
+
+ Currently all such types also begin with an upper case 'T'. + That probably needs some resolution to distinguish for template names. + The suffix _t is never used. +
Structure Names
Structures begin with an upper case 'S'. For example, SMyStructure. + The suffix _s is never used.
Enumerations Names @@ -2835,6 +2845,7 @@ error:
Enumerations begin with an upper case 'E'. For example, EMyEnumeration. + The suffix _e is never used.