Commit graph

15 commits

Author SHA1 Message Date
Jeremie Guichard
65c91e833c Add Coding conventions section in CodingStyle file
Add section about string manipulation
Moved some of the existing conventions into the new section:
 - variable declarations
 - text strings
 - UI text style

Update CONTRIBUTING.md with references to CodingStyle file

Signed-off-by: Jeremie Guichard <djebrest@gmail.com>
2018-04-10 08:18:32 -07:00
Jeremie Guichard
f633cb81ae Fix minor typos and spelling mistakes in README.md and related
Signed-off-by: Jeremie Guichard <djebrest@gmail.com>
2018-04-09 07:48:01 -07:00
Dirk Hohndel
f09b46d47a CodingStype: add explanation how to install the QtCreator settings
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-09-07 07:58:35 -07:00
Lubomir I. Ivanov
120088fd16 CodingStyle: add an extra line for the braces explaination
The extra call "dosomethingelse()" is added with the
intention that user will not be confused to add braces
around single lined "if" conditions.

Signed-off-by: Lubomir I. Ivanov <neolit123@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-03-23 08:40:32 -07:00
Dirk Hohndel
2ffdb8945f Update CodingStyle
Initializers were not documenting what we actually do.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2015-03-23 05:54:16 -07:00
Tim Wootton
a9bb191dba Adds advice on text strings to style guide
Signed-off-by: Tim Wootton <tim@tee-jay.demon.co.uk>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-12-17 07:51:57 -08:00
Dirk Hohndel
45acec0e25 Small update to CodingStyle document
Mention variable declarations (they should be at the beginning of code
blocks).

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-07-16 09:16:47 -07:00
Jeremiah Mahler
81ec6f3176 CodingStyle "to" "too" typo
Small typo in CodingStyle.
".. in this file to." should be "... in this file too."

Signed-off-by: Jeremiah Mahler <jmmahler@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-05-10 09:41:17 -07:00
Lakshman
e8ee701d35 Fixed Subsurface coding style for classes in vim.
With the current suggested settings in `CodingStyle` content
of class blocks gets indented. To avoid this, value `g0` is
added to cinoptions. In addition to this `TODO` thing, few
additional options are suggested.

 - Included the value `(0` to cinoptions, to comply with the
   discontinuation of continuous lines as per Subsurface
   coding style recommendations.

Add two options that aren't exactly about coding style but about
convenience:

 - `hls` option to highlight all search options.
 - `is` option to do incremental search

Signed-off-by: Lakshman Anumolu <acrlakshman@gmail.com>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-03-10 11:34:49 -07:00
Joshua Wambua
a8bce0bb9f Fix minor spelling error in CodingStyle
Fixes a minor spelling error in the CodingStyle file.

Signed-off-by: Joshua Wambua <joshua@megvel.me.ke>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-28 07:57:09 -08:00
Anton Lundin
5bbe931b6c Add some notes about vim settings for our style
Basic vim settings to mostly follow our coding style.

Signed-off-by: Anton Lundin <glance@acc.umu.se>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-27 18:55:17 -08:00
Dirk Hohndel
0307f3d543 Add explanations and Emacs / QtCreator settings to CodingStyle
These may not be perfect, but they are a start.

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-02-27 07:57:22 -08:00
Thiago Macieira
a566dbdaf7 Add info to the CodingStyle for C++ constructors
Signed-off-by: Thiago Macieira <thiago@macieira.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-22 08:28:43 -08:00
Dirk Hohndel
2c8e8f8cec Add switch statement to CodingStyle
Requested-by: Thiago Macieira <thiago@macieira.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-16 12:58:06 +07:00
Dirk Hohndel
a27f67c026 Whitespace and coding style updates
Another futile attempt to cleanup the code and make coding style and
whitespace consistent. I tried to add a file that describes the key points
of our coding style. I have no illusions that this will help the least
bit...

This commit should ONLY change whitespace

Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-01-16 11:50:56 +07:00