Changeset 72781 in vbox

Timestamp:

Jul 1, 2018 11:29:08 AM (6 years ago)

Author:

vboxsync

Message:

doc/VBox-CodingGuidelines.cpp: Added links to local coding guidelines around VBox.

File:

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

trunk/doc/VBox-CodingGuidelines.cpp

@@ -21 +21 @@
  * qemu. Qemu is using whatever the frenchman does.
  *
- * There are a few compulsory rules and a bunch of optional ones. The following
- * sections will describe these in details. In addition there is a section of
- * Subversion 'rules'.
+ * There are a few compulsory rules and a bunch of optional ones.  The following
+ * sections will describe these in details.  In addition there is a section of
+ * Subversion 'rules' and one with links to local coding guidelines.
  *
  *
@@ -905 +905 @@
  *
  * (Inspired by mozilla tree rules.)
+ *
+ *
+ * @section sec_vbox_guideline_local        Local Coding Guidelines
+ *
+ * VirtualBox is a large project, so there are parts with additional guidelines
+ * that extends the above ones.
+ *
+ * <ul>
+ *
+ *   <li> src/VBox/VMM/: @ref pg_vmm_guideline
+ *        (src/VBox/VMM/Docs-CodingGuidelines.cpp)
+ *
+ *   <li> src/VBox/ValidationKit/: @ref pg_validationkit_guideline
+ *        (src/VBox/ValidationKit/ValidationKitCodingGuidelines.cpp)
+ *
+ *   <li> src/VBox/Runtime/: @ref sec_vbox_guideline_optional is mandatory.
+ *
+ *   <li> src/VBox/Frontends/VirtualBox/: @ref sec_vbox_guideline_compulsory_cppqtgui
+ *
+ *   <li> src/VBox/Main: @ref sec_vbox_guideline_compulsory_cppmain
+ *
+ *
+ * </ul>
+ *
  */