1 This is the coding guideline for Kdenlive.
5 Please don't use for existing files. It is very likely to break manual tweaks like:
6 const int componentFlags = (ui->cbY->isChecked() ? 1 : 0) * HistogramGenerator::ComponentY
7 | (ui->cbS->isChecked() ? 1 : 0) * HistogramGenerator::ComponentSum
8 | (ui->cbR->isChecked() ? 1 : 0) * HistogramGenerator::ComponentR
9 | (ui->cbG->isChecked() ? 1 : 0) * HistogramGenerator::ComponentG
10 | (ui->cbB->isChecked() ? 1 : 0) * HistogramGenerator::ComponentB;
11 which are intended to improve readability.
14 When adding a new feature, add it to the CHANGELOG file. Features often are not mentioned
15 in the bug tracker; adding it to the changelog helps keeping track of them.
18 Bugs often are in mantis. When fixing a bug, add a link to the bug tracker entry in the commit log
19 and close the bug there.
20 If the bug is not in mantis, it should be (a) added (and marked as fixed) if it is an important bug,
21 or (b) not added otherwise.
26 Each class should be shortly described in its header file.
29 Public functions should be documented as well in the header file. Especially regarding side effects!
30 (What does a programmer neeed to know in order to use this function without reading the whole source code?)
33 are very helpful for commands (function calls, calculations) that are not obvious. For example, what
34 does this function call do?
36 davinci.drawLine(0, y, scopeRect().size().width()-RGBParadeGenerator::distRight, y);
38 A short comment makes it obvious (also helps locating bugs when something needs to be fixed):
40 // Draw a horizontal line through the current mouse position
41 davinci.drawLine(0, y, scopeRect().size().width()-RGBParadeGenerator::distRight, y);
45 The docs can be generated by using doxygen (doxygen DoxyConfig in the main directory).
46 See [1] for an overview of doxygen commands.
47 Often used: \brief, \param, \return
51 This part is based on Krita's HACKING file[2].
53 Indentation, Braces etc.
54 4 Spaces for indentation. Always braces.
55 This is, according to the Qt4 coding style, which is documented here:
56 http://techbase.kde.org/Policies/Kdelibs_Coding_Style
59 Avoid as much as possible #includes in header files; use forward declarations
63 Avoid as much as possible initializers in the body of the constructor. Use
64 initializer lists instead.
67 Use only m_ for class-level variables. No other scope prefixes; no g_, l_,
68 no 'p' for pointer variables.
71 Use shared pointers wherever possible.
74 Getter/setters are named x() for getters and setX(int x) for setters. If you
75 come across violations of this rule, change the code.
78 Functions should be named in camelBackedFashion, to conform to Qt's standards.
79 If you encounter functions in c_style_like_this, feel free to rename. Also:
80 verbNoun -- i.e., rotateLayer, not layer_rotate. The latter is a true c-ism,
81 introduced by a language that needs to prefix the 'class' name to every function
82 in order to have something that not quite OO.
84 Variable/Parameter names
85 Variable/parameter names start with an undercast letter. A name composed of different
86 words is done in camelBackedStyle.
89 It's preferred (and strongly preferred) to have only one class per .h/.cpp file.
90 (Which is logical, because otherwise you won't be able to keep to the naming scheme.)
93 Keep the source airy and open. In particular, there should be empty lines between function
94 declarations and definitions.
97 Prefix slots with slot and signals with signal: slotUpdateSelection, signalSelectionUpdated.
100 Use the standard !, !=, ==, && etc style, not the "not", "and" etc. style. Keep kdenlive code
101 using one, easily recognizable, C++ style.
105 These rules are merely guidelines for making the code consistent and more readable. In some cases
106 it makes sense to not follow some of the points mentioned above.
109 [1] http://www.stack.nl/~dimitri/doxygen/commands.html
110 [2] http://quickgit.kde.org/?p=calligra.git&a=blob_plain&h=3e8fcab9dd3588c0228498af2795d3b714b73d42&f=krita/HACKING