Changeset 62705 in vbox for trunk/doc

Timestamp:

Jul 29, 2016 8:18:30 PM (9 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

109279

Message:

CodingGuidelines: Reverted r109277 (PC) and clarified 'c' instead which was my actual intention.

File:

• trunk/doc/VBox-CodingGuidelines.cpp (modified) (4 diffs)

trunk/doc/VBox-CodingGuidelines.cpp

@@ -60 +60 @@
  *        them from defines.
  *
- *      - Pointer typedefs start with 'P'.
+ *      - Pointer typedefs start with 'P'. If pointer to const then 'PC'.
  *
  *      - Function typedefs start with 'FN'. If pointer to FN then 'PFN'.
@@ -511 +511 @@
  *
  *      - The 'c' prefix means count.  For instance 'cbBlock' could be read,
- *        count of bytes in block.
+ *        count of bytes in block. (1)
  *
  *      - The 'cx' prefix means width (count of 'x' units).
@@ -583 +583 @@
  *      - The 'pcsz' prefix is used to indicate constant string pointers in
  *        parts of the code.  Most code uses 'psz' for const and non-const
- *        string pointers.
+ *        string pointers, so please ignore this one.
  *
  *      - The 'l' prefix means (signed) long.  We try avoid using this,
@@ -594 +594 @@
  *        long' on 64-bit non-Windows platforms and can cause confusion.
  *        Alternatives: 'u' or 'u32'.  [type]
+ *
+ *
+ * (1)  Except in the occasional 'pcsz' prefix, the 'c' prefix is never ever
+ *      used in the meaning 'const'.
  *
  *