summaryrefslogtreecommitdiff
path: root/doc/api/coding-style.qdoc
diff options
context:
space:
mode:
authorhjk <qthjk@ovi.com>2013-01-14 12:58:14 +0100
committerhjk <qthjk@ovi.com>2013-01-14 17:57:37 +0100
commit80631f60f8e64e63fdee84cd9d7b66fe8ee2cd19 (patch)
treed062cab203b0584fb4f55b2200976d8f2739fbb1 /doc/api/coding-style.qdoc
parentb09f0c61cf26c1b5c469c47b40fc629ab8181a46 (diff)
downloadqt-creator-80631f60f8e64e63fdee84cd9d7b66fe8ee2cd19.tar.gz
CodingStyle: Recommend space after //
This codifies the practice we have been following for a while and has been advertised on the mailing list now. Change-Id: I25cc41a14586e8f6735a689c53007c2800bee963 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Diffstat (limited to 'doc/api/coding-style.qdoc')
-rw-r--r--doc/api/coding-style.qdoc5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/api/coding-style.qdoc b/doc/api/coding-style.qdoc
index fbb1914bd7..ccca5bb475 100644
--- a/doc/api/coding-style.qdoc
+++ b/doc/api/coding-style.qdoc
@@ -254,6 +254,11 @@
}
\endcode
+ \section3 Comments
+
+ In general, put one space after "//". To align text in multiline
+ comments, you can insert multiple spaces.
+
\section2 Braces
As a base rule, place the left curly brace on the same line as the