Changeset 21449 in vbox for trunk/doc

Timestamp:

Jul 9, 2009 4:24:17 PM (16 years ago)

Author:

vboxsync

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

49862

Message:

Tried of fixing missing/wrong svn attribtues, added a line about property with a pointer to svn-ps.sh. Also added the missing line about #else/#endif comments.

File:

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

trunk/doc/VBox-CodingGuidelines.cpp

@@ -116 +116 @@
  *        comments, only ANSI C comments!
  *
+ *      - Comments on \#else indicates what begins while the comment on a
+ *        \#endif indicates what ended.
+ *
  *
  * (1) It is common practice on Unix to have a single symbol namespace for an
@@ -125 +128 @@
  *     __declspect(export) constructs are the main reason for this.
  *     OTOH, we do perhaps have a bit too detailed graining of this in VMM...
- *
  *
  *
@@ -198 +200 @@
  *
  *
- *
  * @subsection sec_vbox_guideline_compulsory_cppmain   C++ guidelines for Main
  *
@@ -234 +235 @@
  *  -  std::auto_ptr<> in general; that part of the C++ standard is just broken.
  *     Write a destructor that calls delete.
+ *
  *
  *
@@ -413 +415 @@
  * Some of the warnings can seem kind of innocent at first glance. So, let's take the
  * most common ones and explain them.
+ *
  *
  * @subsection sec_vbox_guideline_warnings_signed_unsigned_compare      Signed / Unsigned Compare
@@ -437 +440 @@
  *
  *
+ *
  * @section sec_vbox_guideline_svn          Subversion Commit Rules
  *
@@ -454 +458 @@
  *      - If you make a user visible change, such as fixing a reported bug,
  *        make sure you add an entry to doc/manual/user_ChangeLogImpl.xml.
+ *
+ *      - If you are adding files make sure set the right attributes.
+ *        svn-ps.sh/cmd was created for this purpose, please make use of it.
  *
  *