Skip to content

Commit

Permalink
Clarify guidelines and fix some typos
Browse files Browse the repository at this point in the history
  • Loading branch information
thalieht committed May 9, 2018
1 parent 20ca908 commit fb2bcb5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CODING_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,11 +239,11 @@ The headers should be placed in the following group order:
4. Boost library headers
5. Libtorrent headers
6. Qt headers
7. qBittorrent own headers, starting from *base* headers.
7. qBittorrent's own headers, starting from the *base* headers.
The headers should be ordered alphabetically within each group.
If there are conditionals for the same header group, then put them at the bottom of the respective group.
If there are conditionals for the different header groups, then put them above of the "qBittorrent own headers" group.
If there are conditionals that contain headers from several different header groups, then put them above the "qBittorrent's own headers" group.
One exception is the header containing the library version (for example, QtGlobal), this particular header isn't constrained by the aforementioned order.
Expand Down Expand Up @@ -285,13 +285,13 @@ Example:
#include <QFont>
#endif
// conditional for the different header groups
// conditional that contains headers from several different header groups
#if LIBTORRENT_VERSION_NUM >= 10100
#include <memory>
#include <QElapsedTimer>
#endif
// qBittorrent own headers
// qBittorrent's own headers
#include "base/bittorrent/infohash.h"
#include "anothermodule.h"
#include "ui_examplewidget.h"
Expand Down

0 comments on commit fb2bcb5

Please sign in to comment.