Skip to content

Commit 1035111

Browse files
committed
doc: Add a link to clang-format file for QtCreator
1 parent 2f7d9e6 commit 1035111

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/codingConventions.doxygen

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@
2525

2626
The increasing number of contributors require that we clearly define coding rules and guidelines. Although for historical reasons the current code of Stellarium does not always comply to these rules, they should now be respected for any addition or modification of the code.
2727

28-
Settings for <a href="http://doc.qt.io/qtcreator/index.html">QtCreator</a> IDE you can get <a href="stellarium-ide.xml">here</a>.
28+
For <a href="http://doc.qt.io/qtcreator/index.html">QtCreator</a> IDE you can find the settings below. Note that to have the ClangFormat settings work as expected you need to disable *Clean whitespace* in *Preferences* → *Text Editor* → *Behavior* → *Cleanups Upon Saving*, otherwise editing will work fine, but saving will reset the formatting of the file to a wrong state.
29+
- <a href="https://github.com/Stellarium/stellarium/blob/master/.clang-format">ClangFormat config file</a> for QtCreator ≥ 13,
30+
- <a href="stellarium-ide.xml">Legacy XML file</a> for the built-in indentor of QtCreator < 13.
31+
2932

3033
@section stylistic_conventions_sec Stylistic Conventions
3134
- Source code should use the ASCII character set. Characters such as '&egrave;'

0 commit comments

Comments
 (0)