forked from mavlink/qgroundcontrol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
CodingStyle.h
103 lines (73 loc) · 3.69 KB
/
CodingStyle.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*=====================================================================
QGroundControl Open Source Ground Control Station
(c) 2009 - 2015 QGROUNDCONTROL PROJECT <http://www.qgroundcontrol.org>
This file is part of the QGROUNDCONTROL project
QGROUNDCONTROL is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
QGROUNDCONTROL is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with QGROUNDCONTROL. If not, see <http://www.gnu.org/licenses/>.
======================================================================*/
// The above copyright block should be at the top of every file.
/// @file
/// @brief This is an example class header file which is used to describe the QGroundControl
/// coding style. In general almost everything in here has some coding style meaning.
/// For example, note how this doxygen block uses the /// variant as the preferred style
/// of doxygen marker. Not all style choices are explained.
///
/// @author Don Gagne <don@thegagnes.com>
#ifndef CODINGSTYLE_H
#define CODINGSTYLE_H
#include <QObject>
#include <QMap>
#include <QXmlStreamReader>
#include <QLoggingCategory>
#include <limits.h>
#include "Fact.h"
#include "UASInterface.h"
// Note how the Qt headers, Syste, headers and the QGroundControl headers above are kept in seperate groups
// If you are going to use a logging category for a class it should have the same name as the class
// with a suffix of Log.
Q_DECLARE_LOGGING_CATEGORY(CodingStyleLog)
/// Here is the class documentation. Class names are PascalCase. If you override any of the Qt base classes to provide
/// generic base implementations for widespread use prefix the class name with QGC. For example:
/// QGCMessageBox - is a QGC special vesion of Qt MessageBox
/// QGCPalette - is a QGC special version of Qt Palette
/// For normal single use classes do no prefix them name with QGC.
class CodingStyle : public QObject
{
Q_OBJECT
public:
CodingStyle(QObject* parent = NULL);
~CodingStyle();
/// Document public methods which are non-obvious in the header file
bool publicMethod1(void);
signals:
/// Document signals which are non-obvious in the header file
void qtSignal(void);
public slots:
// Public slots should only be used if the slot is connected to from another class. Majority of slots
// should be private.
void publicSlot(void);
// Don't use protected methods or variables unless the class is specifically meant to be used as a base class.
protected:
int _protectedVariable; ///< variable names are camelCase
void _protectedMethod(void); ///< method names are camelCase
private slots:
void _privateSlot(void);
private:
// Private methods and variable names begin with an "_". Documentation for
// non-obvious private methods goes in the code file, not the header.
void _privateMethod(void);
void _methodWithManyArguments(QWidget* parent, const QString& caption, const QString& dir, Options options1, Options options2, Options options3);
/// Document non-obvious variables in the header file. Long descriptions go here.
int _privateVariable1;
int _privateVariable2; ///< Short descriptions go here
static const int _privateStaticVariable;
};
#endif