summaryrefslogtreecommitdiffstats
path: root/CODINGSTYLE.md
diff options
context:
space:
mode:
authorGravatar jan Iversen <jan@casacondor.com>2019-12-25 10:30:11 +0100
committerGravatar Dirk Hohndel <dirk@hohndel.org>2019-12-26 10:32:52 -0800
commit0241155e4759d06cbc0b612544c494f5ea800a14 (patch)
treef7e7501c9a1d0fb8ae35aae881ec150d3b5e4257 /CODINGSTYLE.md
parent4ef1e9cb28432834e731d8bec14b0865af23d6ed (diff)
downloadsubsurface-0241155e4759d06cbc0b612544c494f5ea800a14.tar.gz
documentation: coding style cpp/h names
Add rule about cpp/h names [Dirk Hohndel: small edits to the rule] Signed-off-by: Jan Iversen <jan@casacondor.com> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
Diffstat (limited to 'CODINGSTYLE.md')
-rw-r--r--CODINGSTYLE.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/CODINGSTYLE.md b/CODINGSTYLE.md
index 37e242df0..0c2f38a67 100644
--- a/CODINGSTYLE.md
+++ b/CODINGSTYLE.md
@@ -102,6 +102,10 @@ other editors that implement this coding style, please add them here.
or outside requirements make camelCase filenames the better (or only) choice,
but absent such an outside reason all file names should be lower case
+* cpp/h file names should usually be identical to the class name but in lower
+ case. Where it seems appropriate, multiple, closely related classes can be
+ in a single file with a more generic name.
+
* switch statements with blocks are a little bit special (to avoid indenting
too far)
```