summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGeorges Basile Stavracas Neto <georges.stavracas@gmail.com>2018-05-12 20:54:23 -0300
committerGeorges Basile Stavracas Neto <georges.stavracas@gmail.com>2018-05-12 20:56:06 -0300
commit8ae16f34f645a3f4de7a15436437a062156a49f2 (patch)
treecff27000a46148bb65fdf014c3287d1a51900e85 /docs
parentc5417d8916b9ca9ae75aef10a41fde4d5070d271 (diff)
downloadgnome-control-center-8ae16f34f645a3f4de7a15436437a062156a49f2.tar.gz
docs: Document style of comments
Diffstat (limited to 'docs')
-rw-r--r--docs/HACKING.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/HACKING.md b/docs/HACKING.md
index aa798d44e..8415c2e3d 100644
--- a/docs/HACKING.md
+++ b/docs/HACKING.md
@@ -10,6 +10,18 @@ The most important rule is: **see the surrounding code, and copy its style**.
Another rule that applies to function declarations is that all parameters are
aligned by the last '*'. There are plenty of examples below.
+## Comments
+
+Comment blocks should be formatted as following:
+
+```c
+/* Single line comment */
+
+/* Multiline comments start at the first line of the comment block,
+ * but have the closing slash a line after. Every line starts with
+ * an asterisk that is aligned with every the rest of the block.
+ */
+
## Header (.h) files
It is organized by the following structure: