-
Notifications
You must be signed in to change notification settings - Fork 0
/
configs.json
6906 lines (6906 loc) · 632 KB
/
configs.json
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"versions": [
"3.5.2",
"3.6.0",
"3.6.1",
"3.6.2",
"3.7.0",
"3.7.1",
"3.8.0",
"3.8.1",
"3.9.0",
"3.9.1",
"4.0.0",
"4.0.1",
"5.0.0",
"5.0.1",
"5.0.2",
"6.0.0",
"6.0.1",
"HEAD"
],
"3.5.2": {
"BasedOnStyle": {
"type": "string",
"doc": "<p> The style used for all options not specifically set in the configuration.</p>\n<p> This option is supported only in the <strong>clang-format</strong> configuration\n (both within <code>-style='{...}'</code> and the <code>.clang-format</code> file).</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LLVM</code>\nA style complying with the <a href=\"http://llvm.org/docs/CodingStandards.html\">LLVM coding standards</a></li>\n<li><code>Google</code>\nA style complying with <a href=\"http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml\">Google's C++ style guide</a></li>\n<li><code>Chromium</code>\nA style complying with <a href=\"http://www.chromium.org/developers/coding-style\">Chromium's style guide</a></li>\n<li><code>Mozilla</code>\nA style complying with <a href=\"https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style\">Mozilla's style guide</a></li>\n<li><code>WebKit</code>\nA style complying with <a href=\"http://www.webkit.org/coding/coding-style.html\">WebKit's style guide</a></li>\n</ul>\n",
"options": [
"LLVM",
"Google",
"Chromium",
"Mozilla",
"WebKit"
]
},
"AccessModifierOffset": {
"type": "int",
"doc": "<p> The extra indent or outdent of access modifiers, e.g. <code>public:</code>.</p>\n"
},
"AlignEscapedNewlinesLeft": {
"type": "bool",
"doc": "<p> If <code>true</code>, aligns escaped newlines as far left as possible.\n Otherwise puts them into the right-most column.</p>\n"
},
"AlignTrailingComments": {
"type": "bool",
"doc": "<p> If <code>true</code>, aligns trailing comments.</p>\n"
},
"AllowAllParametersOfDeclarationOnNextLine": {
"type": "bool",
"doc": "<p> Allow putting all parameters of a function declaration onto\n the next line even if <code>BinPackParameters</code> is <code>false</code>.</p>\n"
},
"AllowShortBlocksOnASingleLine": {
"type": "bool",
"doc": "<p> Allows contracting simple braced statements to a single line.</p>\n<p> E.g., this allows <code>if (a) { return; }</code> to be put on a single line.</p>\n"
},
"AllowShortFunctionsOnASingleLine": {
"type": "ShortFunctionStyle",
"doc": "<p> Dependent on the value, <code>int f() { return 0; }</code> can be put\n on a single line.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>SFS_None</code> (in configuration: <code>None</code>)\nNever merge functions into a single line.</li>\n<li><code>SFS_Inline</code> (in configuration: <code>Inline</code>)\nOnly merge functions defined inside a class.</li>\n<li><code>SFS_All</code> (in configuration: <code>All</code>)\nMerge all functions fitting on a single line.</li>\n</ul>\n",
"options": [
"None",
"Inline",
"All"
]
},
"AllowShortIfStatementsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, <code>if (a) return;</code> can be put on a single\n line.</p>\n"
},
"AllowShortLoopsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, <code>while (true) continue;</code> can be put on a\n single line.</p>\n"
},
"AlwaysBreakBeforeMultilineStrings": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break before multiline string literals.</p>\n"
},
"AlwaysBreakTemplateDeclarations": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break after the <code>template<...></code> of a\n template declaration.</p>\n"
},
"BinPackParameters": {
"type": "bool",
"doc": "<p> If <code>false</code>, a function call's or function definition's parameters\n will either all be on the same line or will have one line each.</p>\n"
},
"BreakBeforeBinaryOperators": {
"type": "bool",
"doc": "<p> If <code>true</code>, binary operators will be placed after line breaks.</p>\n"
},
"BreakBeforeBraces": {
"type": "BraceBreakingStyle",
"doc": "<p> The brace breaking style to use.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>BS_Attach</code> (in configuration: <code>Attach</code>)\nAlways attach braces to surrounding context.</li>\n<li><code>BS_Linux</code> (in configuration: <code>Linux</code>)\nLike <code>Attach</code>, but break before braces on function, namespace and\nclass definitions.</li>\n<li><code>BS_Stroustrup</code> (in configuration: <code>Stroustrup</code>)\nLike <code>Attach</code>, but break before function definitions.</li>\n<li><code>BS_Allman</code> (in configuration: <code>Allman</code>)\nAlways break before braces.</li>\n<li><code>BS_GNU</code> (in configuration: <code>GNU</code>)\nAlways break before braces and add an extra level of indentation to\nbraces of control statements, not to those of class, function\nor other definitions.</li>\n</ul>\n",
"options": [
"Attach",
"Linux",
"Stroustrup",
"Allman",
"GNU"
]
},
"BreakBeforeTernaryOperators": {
"type": "bool",
"doc": "<p> If <code>true</code>, ternary operators will be placed after line breaks.</p>\n"
},
"BreakConstructorInitializersBeforeComma": {
"type": "bool",
"doc": "<p> Always break constructor initializers before commas and align\n the commas with the colon.</p>\n"
},
"ColumnLimit": {
"type": "unsigned",
"doc": "<p> The column limit.</p>\n<p> A column limit of <code>0</code> means that there is no column limit. In this case,\n clang-format will respect the input's line breaking decisions within\n statements unless they contradict other rules.</p>\n"
},
"CommentPragmas": {
"type": "std::string",
"doc": "<p> A regular expression that describes comments with special meaning,\n which should not be split into lines or otherwise changed.</p>\n"
},
"ConstructorInitializerAllOnOneLineOrOnePerLine": {
"type": "bool",
"doc": "<p> If the constructor initializers don't fit on a line, put each\n initializer on its own line.</p>\n"
},
"ConstructorInitializerIndentWidth": {
"type": "unsigned",
"doc": "<p> The number of characters to use for indentation of constructor\n initializer lists.</p>\n"
},
"ContinuationIndentWidth": {
"type": "unsigned",
"doc": "<p> Indent width for line continuations.</p>\n"
},
"Cpp11BracedListStyle": {
"type": "bool",
"doc": "<p> If <code>true</code>, format braced lists as best suited for C++11 braced\n lists.</p>\n<p> Important differences:</p>\n<ul>\n<li>No spaces inside the braced list.</li>\n<li>No line break before the closing brace.</li>\n<li><p>Indentation with the continuation indent, not with the block indent.</p>\n<p>Fundamentally, C++11 braced lists are formatted exactly like function\ncalls would be formatted in their place. If the braced list follows a name\n(e.g. a type or variable name), clang-format formats as if the <code>{}</code> were\nthe parentheses of a function call with that name. If there is no name,\na zero-length name is assumed.</p>\n</li>\n</ul>\n"
},
"DerivePointerAlignment": {
"type": "bool",
"doc": "<p> If <code>true</code>, analyze the formatted file for the most common\n alignment of & and *. <code>PointerAlignment</code> is then used only as fallback.</p>\n"
},
"DisableFormat": {
"type": "bool",
"doc": "<p> Disables formatting at all.</p>\n"
},
"ExperimentalAutoDetectBinPacking": {
"type": "bool",
"doc": "<p> If <code>true</code>, clang-format detects whether function calls and\n definitions are formatted with one parameter per line.</p>\n<p> Each call can be bin-packed, one-per-line or inconclusive. If it is\n inconclusive, e.g. completely on one line, but a decision needs to be\n made, clang-format analyzes whether there are other bin-packed cases in\n the input file and act accordingly.</p>\n<p> NOTE: This is an experimental flag, that might go away or be renamed. Do\n not use this in config files, etc. Use at your own risk.</p>\n"
},
"ForEachMacros": {
"type": "std::vector<std::string>",
"doc": "<p> A vector of macros that should be interpreted as foreach loops\n instead of as function calls.</p>\n<p> These are expected to be macros of the form:</p>\n<pre><code class=\"lang- \"> FOREACH(<variable-declaration>, ...)\n <loop-body>\n</code></pre>\n<p> For example: BOOST_FOREACH.</p>\n"
},
"IndentCaseLabels": {
"type": "bool",
"doc": "<p> Indent case labels one level from the switch statement.</p>\n<p> When <code>false</code>, use the same indentation level as for the switch statement.\n Switch statement body is always indented one level more than case labels.</p>\n"
},
"IndentWidth": {
"type": "unsigned",
"doc": "<p> The number of columns to use for indentation.</p>\n"
},
"IndentWrappedFunctionNames": {
"type": "bool",
"doc": "<p> Indent if a function definition or declaration is wrapped after the\n type.</p>\n"
},
"KeepEmptyLinesAtTheStartOfBlocks": {
"type": "bool",
"doc": "<p> If true, empty lines at the start of blocks are kept.</p>\n"
},
"Language": {
"type": "LanguageKind",
"doc": "<p> Language, this format style is targeted at.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LK_None</code> (in configuration: <code>None</code>)\nDo not use.</li>\n<li><code>LK_Cpp</code> (in configuration: <code>Cpp</code>)\nShould be used for C, C++, ObjectiveC, ObjectiveC++.</li>\n<li><code>LK_JavaScript</code> (in configuration: <code>JavaScript</code>)\nShould be used for JavaScript.</li>\n<li><code>LK_Proto</code> (in configuration: <code>Proto</code>)\nShould be used for Protocol Buffers\n(https://developers.google.com/protocol-buffers/).</li>\n</ul>\n",
"options": [
"None",
"Cpp",
"JavaScript",
"Proto"
]
},
"MaxEmptyLinesToKeep": {
"type": "unsigned",
"doc": "<p> The maximum number of consecutive empty lines to keep.</p>\n"
},
"NamespaceIndentation": {
"type": "NamespaceIndentationKind",
"doc": "<p> The indentation used for namespaces.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>NI_None</code> (in configuration: <code>None</code>)\nDon't indent in namespaces.</li>\n<li><code>NI_Inner</code> (in configuration: <code>Inner</code>)\nIndent only in inner namespaces (nested in other namespaces).</li>\n<li><code>NI_All</code> (in configuration: <code>All</code>)\nIndent in all namespaces.</li>\n</ul>\n",
"options": [
"None",
"Inner",
"All"
]
},
"ObjCSpaceAfterProperty": {
"type": "bool",
"doc": "<p> Add a space after <code>@property</code> in Objective-C, i.e. use\n <code>\\@property (readonly)</code> instead of <code>\\@property(readonly)</code>.</p>\n"
},
"ObjCSpaceBeforeProtocolList": {
"type": "bool",
"doc": "<p> Add a space in front of an Objective-C protocol list, i.e. use\n <code>Foo <Protocol></code> instead of <code>Foo<Protocol></code>.</p>\n"
},
"PenaltyBreakBeforeFirstCallParameter": {
"type": "unsigned",
"doc": "<p> The penalty for breaking a function call after "call(".</p>\n"
},
"PenaltyBreakComment": {
"type": "unsigned",
"doc": "<p> The penalty for each line break introduced inside a comment.</p>\n"
},
"PenaltyBreakFirstLessLess": {
"type": "unsigned",
"doc": "<p> The penalty for breaking before the first <code><<</code>.</p>\n"
},
"PenaltyBreakString": {
"type": "unsigned",
"doc": "<p> The penalty for each line break introduced inside a string literal.</p>\n"
},
"PenaltyExcessCharacter": {
"type": "unsigned",
"doc": "<p> The penalty for each character outside of the column limit.</p>\n"
},
"PenaltyReturnTypeOnItsOwnLine": {
"type": "unsigned",
"doc": "<p> Penalty for putting the return type of a function onto its own\n line.</p>\n"
},
"PointerAlignment": {
"type": "PointerAlignmentStyle",
"doc": "<p> Pointer and reference alignment style.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>PAS_Left</code> (in configuration: <code>Left</code>)\nAlign pointer to the left.</li>\n<li><code>PAS_Right</code> (in configuration: <code>Right</code>)\nAlign pointer to the right.</li>\n<li><code>PAS_Middle</code> (in configuration: <code>Middle</code>)\nAlign pointer in the middle.</li>\n</ul>\n",
"options": [
"Left",
"Right",
"Middle"
]
},
"SpaceBeforeAssignmentOperators": {
"type": "bool",
"doc": "<p> If <code>false</code>, spaces will be removed before assignment operators.</p>\n"
},
"SpaceBeforeParens": {
"type": "SpaceBeforeParensOptions",
"doc": "<p> Defines in which cases to put a space before opening parentheses.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>SBPO_Never</code> (in configuration: <code>Never</code>)\nNever put a space before opening parentheses.</li>\n<li><code>SBPO_ControlStatements</code> (in configuration: <code>ControlStatements</code>)\nPut a space before opening parentheses only after control statement\nkeywords (<code>for/if/while...</code>).</li>\n<li><code>SBPO_Always</code> (in configuration: <code>Always</code>)\nAlways put a space before opening parentheses, except when it's\nprohibited by the syntax rules (in function-like macro definitions) or\nwhen determined by other style rules (after unary operators, opening\nparentheses, etc.)</li>\n</ul>\n",
"options": [
"Never",
"ControlStatements",
"Always"
]
},
"SpaceInEmptyParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces may be inserted into '()'.</p>\n"
},
"SpacesBeforeTrailingComments": {
"type": "unsigned",
"doc": "<p> The number of spaces before trailing line comments\n (<code>//</code> - comments).</p>\n<p> This does not affect trailing block comments (<code>/**/</code> - comments) as those\n commonly have different usage patterns and a number of special cases.</p>\n"
},
"SpacesInAngles": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces will be inserted after '<' and before '>' in\n template argument lists</p>\n"
},
"SpacesInCStyleCastParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces may be inserted into C style casts.</p>\n"
},
"SpacesInContainerLiterals": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces are inserted inside container literals (e.g.\n ObjC and Javascript array and dict literals).</p>\n"
},
"SpacesInParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces will be inserted after '(' and before ')'.</p>\n"
},
"Standard": {
"type": "LanguageStandard",
"doc": "<p> Format compatible with this standard, e.g. use\n <code>A<A<int> ></code> instead of <code>A<A<int>></code> for LS_Cpp03.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LS_Cpp03</code> (in configuration: <code>Cpp03</code>)\nUse C++03-compatible syntax.</li>\n<li><code>LS_Cpp11</code> (in configuration: <code>Cpp11</code>)\nUse features of C++11 (e.g. <code>A<A<int>></code> instead of\n<code>A<A<int> ></code>).</li>\n<li><code>LS_Auto</code> (in configuration: <code>Auto</code>)\nAutomatic detection based on the input.</li>\n</ul>\n",
"options": [
"Cpp03",
"Cpp11",
"Auto"
]
},
"TabWidth": {
"type": "unsigned",
"doc": "<p> The number of columns used for tab stops.</p>\n"
},
"UseTab": {
"type": "UseTabStyle",
"doc": "<p> The way to use tab characters in the resulting file.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>UT_Never</code> (in configuration: <code>Never</code>)\nNever use tab.</li>\n<li><code>UT_ForIndentation</code> (in configuration: <code>ForIndentation</code>)\nUse tabs only for indentation.</li>\n<li><code>UT_Always</code> (in configuration: <code>Always</code>)\nUse tabs whenever we need to fill whitespace that spans at least from\none tab stop to the next one.</li>\n</ul>\n",
"options": [
"Never",
"ForIndentation",
"Always"
]
}
},
"3.6.0": {
"BasedOnStyle": {
"type": "string",
"doc": "<p> The style used for all options not specifically set in the configuration.</p>\n<p> This option is supported only in the <strong>clang-format</strong> configuration\n (both within <code>-style='{...}'</code> and the <code>.clang-format</code> file).</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LLVM</code>\nA style complying with the <a href=\"http://llvm.org/docs/CodingStandards.html\">LLVM coding standards</a></li>\n<li><code>Google</code>\nA style complying with <a href=\"http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml\">Google's C++ style guide</a></li>\n<li><code>Chromium</code>\nA style complying with <a href=\"http://www.chromium.org/developers/coding-style\">Chromium's style guide</a></li>\n<li><code>Mozilla</code>\nA style complying with <a href=\"https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style\">Mozilla's style guide</a></li>\n<li><code>WebKit</code>\nA style complying with <a href=\"http://www.webkit.org/coding/coding-style.html\">WebKit's style guide</a></li>\n</ul>\n",
"options": [
"LLVM",
"Google",
"Chromium",
"Mozilla",
"WebKit"
]
},
"AccessModifierOffset": {
"type": "int",
"doc": "<p> The extra indent or outdent of access modifiers, e.g. <code>public:</code>.</p>\n"
},
"AlignAfterOpenBracket": {
"type": "bool",
"doc": "<p> If <code>true</code>, horizontally aligns arguments after an open bracket.</p>\n<p> This applies to round brackets (parentheses), angle brackets and square\n brackets. This will result in formattings like</p>\n<pre><code class=\"lang- \"> someLongFunction(argument1,\n argument2);\n</code></pre>\n"
},
"AlignEscapedNewlinesLeft": {
"type": "bool",
"doc": "<p> If <code>true</code>, aligns escaped newlines as far left as possible.\n Otherwise puts them into the right-most column.</p>\n"
},
"AlignOperands": {
"type": "bool",
"doc": "<p> If <code>true</code>, horizontally align operands of binary and ternary\n expressions.</p>\n"
},
"AlignTrailingComments": {
"type": "bool",
"doc": "<p> If <code>true</code>, aligns trailing comments.</p>\n"
},
"AllowAllParametersOfDeclarationOnNextLine": {
"type": "bool",
"doc": "<p> Allow putting all parameters of a function declaration onto\n the next line even if <code>BinPackParameters</code> is <code>false</code>.</p>\n"
},
"AllowShortBlocksOnASingleLine": {
"type": "bool",
"doc": "<p> Allows contracting simple braced statements to a single line.</p>\n<p> E.g., this allows <code>if (a) { return; }</code> to be put on a single line.</p>\n"
},
"AllowShortCaseLabelsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, short case labels will be contracted to a single line.</p>\n"
},
"AllowShortFunctionsOnASingleLine": {
"type": "ShortFunctionStyle",
"doc": "<p> Dependent on the value, <code>int f() { return 0; }</code> can be put\n on a single line.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>SFS_None</code> (in configuration: <code>None</code>)\nNever merge functions into a single line.</li>\n<li><code>SFS_Inline</code> (in configuration: <code>Inline</code>)\nOnly merge functions defined inside a class.</li>\n<li><code>SFS_Empty</code> (in configuration: <code>Empty</code>)\nOnly merge empty functions.</li>\n<li><code>SFS_All</code> (in configuration: <code>All</code>)\nMerge all functions fitting on a single line.</li>\n</ul>\n",
"options": [
"None",
"Inline",
"Empty",
"All"
]
},
"AllowShortIfStatementsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, <code>if (a) return;</code> can be put on a single\n line.</p>\n"
},
"AllowShortLoopsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, <code>while (true) continue;</code> can be put on a\n single line.</p>\n"
},
"AlwaysBreakAfterDefinitionReturnType": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break after function definition return types.</p>\n<p> More truthfully called 'break before the identifier following the type\n in a function definition'. PenaltyReturnTypeOnItsOwnLine becomes\n irrelevant.</p>\n"
},
"AlwaysBreakBeforeMultilineStrings": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break before multiline string literals.</p>\n"
},
"AlwaysBreakTemplateDeclarations": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break after the <code>template<...></code> of a\n template declaration.</p>\n"
},
"BinPackArguments": {
"type": "bool",
"doc": "<p> If <code>false</code>, a function call's arguments will either be all on the\n same line or will have one line each.</p>\n"
},
"BinPackParameters": {
"type": "bool",
"doc": "<p> If <code>false</code>, a function declaration's or function definition's\n parameters will either all be on the same line or will have one line each.</p>\n"
},
"BreakBeforeBinaryOperators": {
"type": "BinaryOperatorStyle",
"doc": "<p> The way to wrap binary operators.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>BOS_None</code> (in configuration: <code>None</code>)\nBreak after operators.</li>\n<li><code>BOS_NonAssignment</code> (in configuration: <code>NonAssignment</code>)\nBreak before operators that aren't assignments.</li>\n<li><code>BOS_All</code> (in configuration: <code>All</code>)\nBreak before operators.</li>\n</ul>\n",
"options": [
"None",
"NonAssignment",
"All"
]
},
"BreakBeforeBraces": {
"type": "BraceBreakingStyle",
"doc": "<p> The brace breaking style to use.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>BS_Attach</code> (in configuration: <code>Attach</code>)\nAlways attach braces to surrounding context.</li>\n<li><code>BS_Linux</code> (in configuration: <code>Linux</code>)\nLike <code>Attach</code>, but break before braces on function, namespace and\nclass definitions.</li>\n<li><code>BS_Stroustrup</code> (in configuration: <code>Stroustrup</code>)\nLike <code>Attach</code>, but break before function definitions, and 'else'.</li>\n<li><code>BS_Allman</code> (in configuration: <code>Allman</code>)\nAlways break before braces.</li>\n<li><code>BS_GNU</code> (in configuration: <code>GNU</code>)\nAlways break before braces and add an extra level of indentation to\nbraces of control statements, not to those of class, function\nor other definitions.</li>\n</ul>\n",
"options": [
"Attach",
"Linux",
"Stroustrup",
"Allman",
"GNU"
]
},
"BreakBeforeTernaryOperators": {
"type": "bool",
"doc": "<p> If <code>true</code>, ternary operators will be placed after line breaks.</p>\n"
},
"BreakConstructorInitializersBeforeComma": {
"type": "bool",
"doc": "<p> Always break constructor initializers before commas and align\n the commas with the colon.</p>\n"
},
"ColumnLimit": {
"type": "unsigned",
"doc": "<p> The column limit.</p>\n<p> A column limit of <code>0</code> means that there is no column limit. In this case,\n clang-format will respect the input's line breaking decisions within\n statements unless they contradict other rules.</p>\n"
},
"CommentPragmas": {
"type": "std::string",
"doc": "<p> A regular expression that describes comments with special meaning,\n which should not be split into lines or otherwise changed.</p>\n"
},
"ConstructorInitializerAllOnOneLineOrOnePerLine": {
"type": "bool",
"doc": "<p> If the constructor initializers don't fit on a line, put each\n initializer on its own line.</p>\n"
},
"ConstructorInitializerIndentWidth": {
"type": "unsigned",
"doc": "<p> The number of characters to use for indentation of constructor\n initializer lists.</p>\n"
},
"ContinuationIndentWidth": {
"type": "unsigned",
"doc": "<p> Indent width for line continuations.</p>\n"
},
"Cpp11BracedListStyle": {
"type": "bool",
"doc": "<p> If <code>true</code>, format braced lists as best suited for C++11 braced\n lists.</p>\n<p> Important differences:</p>\n<ul>\n<li>No spaces inside the braced list.</li>\n<li>No line break before the closing brace.</li>\n<li><p>Indentation with the continuation indent, not with the block indent.</p>\n<p>Fundamentally, C++11 braced lists are formatted exactly like function\ncalls would be formatted in their place. If the braced list follows a name\n(e.g. a type or variable name), clang-format formats as if the <code>{}</code> were\nthe parentheses of a function call with that name. If there is no name,\na zero-length name is assumed.</p>\n</li>\n</ul>\n"
},
"DerivePointerAlignment": {
"type": "bool",
"doc": "<p> If <code>true</code>, analyze the formatted file for the most common\n alignment of & and *. <code>PointerAlignment</code> is then used only as fallback.</p>\n"
},
"DisableFormat": {
"type": "bool",
"doc": "<p> Disables formatting at all.</p>\n"
},
"ExperimentalAutoDetectBinPacking": {
"type": "bool",
"doc": "<p> If <code>true</code>, clang-format detects whether function calls and\n definitions are formatted with one parameter per line.</p>\n<p> Each call can be bin-packed, one-per-line or inconclusive. If it is\n inconclusive, e.g. completely on one line, but a decision needs to be\n made, clang-format analyzes whether there are other bin-packed cases in\n the input file and act accordingly.</p>\n<p> NOTE: This is an experimental flag, that might go away or be renamed. Do\n not use this in config files, etc. Use at your own risk.</p>\n"
},
"ForEachMacros": {
"type": "std::vector<std::string>",
"doc": "<p> A vector of macros that should be interpreted as foreach loops\n instead of as function calls.</p>\n<p> These are expected to be macros of the form:</p>\n<pre><code class=\"lang- \"> FOREACH(<variable-declaration>, ...)\n <loop-body>\n</code></pre>\n<p> For example: BOOST_FOREACH.</p>\n"
},
"IndentCaseLabels": {
"type": "bool",
"doc": "<p> Indent case labels one level from the switch statement.</p>\n<p> When <code>false</code>, use the same indentation level as for the switch statement.\n Switch statement body is always indented one level more than case labels.</p>\n"
},
"IndentWidth": {
"type": "unsigned",
"doc": "<p> The number of columns to use for indentation.</p>\n"
},
"IndentWrappedFunctionNames": {
"type": "bool",
"doc": "<p> Indent if a function definition or declaration is wrapped after the\n type.</p>\n"
},
"KeepEmptyLinesAtTheStartOfBlocks": {
"type": "bool",
"doc": "<p> If true, empty lines at the start of blocks are kept.</p>\n"
},
"Language": {
"type": "LanguageKind",
"doc": "<p> Language, this format style is targeted at.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LK_None</code> (in configuration: <code>None</code>)\nDo not use.</li>\n<li><code>LK_Cpp</code> (in configuration: <code>Cpp</code>)\nShould be used for C, C++, ObjectiveC, ObjectiveC++.</li>\n<li><code>LK_Java</code> (in configuration: <code>Java</code>)\nShould be used for Java.</li>\n<li><code>LK_JavaScript</code> (in configuration: <code>JavaScript</code>)\nShould be used for JavaScript.</li>\n<li><code>LK_Proto</code> (in configuration: <code>Proto</code>)\nShould be used for Protocol Buffers\n(https://developers.google.com/protocol-buffers/).</li>\n</ul>\n",
"options": [
"None",
"Cpp",
"Java",
"JavaScript",
"Proto"
]
},
"MaxEmptyLinesToKeep": {
"type": "unsigned",
"doc": "<p> The maximum number of consecutive empty lines to keep.</p>\n"
},
"NamespaceIndentation": {
"type": "NamespaceIndentationKind",
"doc": "<p> The indentation used for namespaces.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>NI_None</code> (in configuration: <code>None</code>)\nDon't indent in namespaces.</li>\n<li><code>NI_Inner</code> (in configuration: <code>Inner</code>)\nIndent only in inner namespaces (nested in other namespaces).</li>\n<li><code>NI_All</code> (in configuration: <code>All</code>)\nIndent in all namespaces.</li>\n</ul>\n",
"options": [
"None",
"Inner",
"All"
]
},
"ObjCBlockIndentWidth": {
"type": "unsigned",
"doc": "<p> The number of characters to use for indentation of ObjC blocks.</p>\n"
},
"ObjCSpaceAfterProperty": {
"type": "bool",
"doc": "<p> Add a space after <code>@property</code> in Objective-C, i.e. use\n <code>\\@property (readonly)</code> instead of <code>\\@property(readonly)</code>.</p>\n"
},
"ObjCSpaceBeforeProtocolList": {
"type": "bool",
"doc": "<p> Add a space in front of an Objective-C protocol list, i.e. use\n <code>Foo <Protocol></code> instead of <code>Foo<Protocol></code>.</p>\n"
},
"PenaltyBreakBeforeFirstCallParameter": {
"type": "unsigned",
"doc": "<p> The penalty for breaking a function call after "call(".</p>\n"
},
"PenaltyBreakComment": {
"type": "unsigned",
"doc": "<p> The penalty for each line break introduced inside a comment.</p>\n"
},
"PenaltyBreakFirstLessLess": {
"type": "unsigned",
"doc": "<p> The penalty for breaking before the first <code><<</code>.</p>\n"
},
"PenaltyBreakString": {
"type": "unsigned",
"doc": "<p> The penalty for each line break introduced inside a string literal.</p>\n"
},
"PenaltyExcessCharacter": {
"type": "unsigned",
"doc": "<p> The penalty for each character outside of the column limit.</p>\n"
},
"PenaltyReturnTypeOnItsOwnLine": {
"type": "unsigned",
"doc": "<p> Penalty for putting the return type of a function onto its own\n line.</p>\n"
},
"PointerAlignment": {
"type": "PointerAlignmentStyle",
"doc": "<p> Pointer and reference alignment style.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>PAS_Left</code> (in configuration: <code>Left</code>)\nAlign pointer to the left.</li>\n<li><code>PAS_Right</code> (in configuration: <code>Right</code>)\nAlign pointer to the right.</li>\n<li><code>PAS_Middle</code> (in configuration: <code>Middle</code>)\nAlign pointer in the middle.</li>\n</ul>\n",
"options": [
"Left",
"Right",
"Middle"
]
},
"SpaceAfterCStyleCast": {
"type": "bool",
"doc": "<p> If <code>true</code>, a space may be inserted after C style casts.</p>\n"
},
"SpaceBeforeAssignmentOperators": {
"type": "bool",
"doc": "<p> If <code>false</code>, spaces will be removed before assignment operators.</p>\n"
},
"SpaceBeforeParens": {
"type": "SpaceBeforeParensOptions",
"doc": "<p> Defines in which cases to put a space before opening parentheses.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>SBPO_Never</code> (in configuration: <code>Never</code>)\nNever put a space before opening parentheses.</li>\n<li><code>SBPO_ControlStatements</code> (in configuration: <code>ControlStatements</code>)\nPut a space before opening parentheses only after control statement\nkeywords (<code>for/if/while...</code>).</li>\n<li><code>SBPO_Always</code> (in configuration: <code>Always</code>)\nAlways put a space before opening parentheses, except when it's\nprohibited by the syntax rules (in function-like macro definitions) or\nwhen determined by other style rules (after unary operators, opening\nparentheses, etc.)</li>\n</ul>\n",
"options": [
"Never",
"ControlStatements",
"Always"
]
},
"SpaceInEmptyParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces may be inserted into '()'.</p>\n"
},
"SpacesBeforeTrailingComments": {
"type": "unsigned",
"doc": "<p> The number of spaces before trailing line comments\n (<code>//</code> - comments).</p>\n<p> This does not affect trailing block comments (<code>/**/</code> - comments) as those\n commonly have different usage patterns and a number of special cases.</p>\n"
},
"SpacesInAngles": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces will be inserted after '<' and before '>' in\n template argument lists</p>\n"
},
"SpacesInCStyleCastParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces may be inserted into C style casts.</p>\n"
},
"SpacesInContainerLiterals": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces are inserted inside container literals (e.g.\n ObjC and Javascript array and dict literals).</p>\n"
},
"SpacesInParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces will be inserted after '(' and before ')'.</p>\n"
},
"SpacesInSquareBrackets": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces will be inserted after '[' and before ']'.</p>\n"
},
"Standard": {
"type": "LanguageStandard",
"doc": "<p> Format compatible with this standard, e.g. use\n <code>A<A<int> ></code> instead of <code>A<A<int>></code> for LS_Cpp03.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LS_Cpp03</code> (in configuration: <code>Cpp03</code>)\nUse C++03-compatible syntax.</li>\n<li><code>LS_Cpp11</code> (in configuration: <code>Cpp11</code>)\nUse features of C++11 (e.g. <code>A<A<int>></code> instead of\n<code>A<A<int> ></code>).</li>\n<li><code>LS_Auto</code> (in configuration: <code>Auto</code>)\nAutomatic detection based on the input.</li>\n</ul>\n",
"options": [
"Cpp03",
"Cpp11",
"Auto"
]
},
"TabWidth": {
"type": "unsigned",
"doc": "<p> The number of columns used for tab stops.</p>\n"
},
"UseTab": {
"type": "UseTabStyle",
"doc": "<p> The way to use tab characters in the resulting file.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>UT_Never</code> (in configuration: <code>Never</code>)\nNever use tab.</li>\n<li><code>UT_ForIndentation</code> (in configuration: <code>ForIndentation</code>)\nUse tabs only for indentation.</li>\n<li><code>UT_Always</code> (in configuration: <code>Always</code>)\nUse tabs whenever we need to fill whitespace that spans at least from\none tab stop to the next one.</li>\n</ul>\n",
"options": [
"Never",
"ForIndentation",
"Always"
]
}
},
"3.6.1": {
"BasedOnStyle": {
"type": "string",
"doc": "<p> The style used for all options not specifically set in the configuration.</p>\n<p> This option is supported only in the <strong>clang-format</strong> configuration\n (both within <code>-style='{...}'</code> and the <code>.clang-format</code> file).</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LLVM</code>\nA style complying with the <a href=\"http://llvm.org/docs/CodingStandards.html\">LLVM coding standards</a></li>\n<li><code>Google</code>\nA style complying with <a href=\"http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml\">Google's C++ style guide</a></li>\n<li><code>Chromium</code>\nA style complying with <a href=\"http://www.chromium.org/developers/coding-style\">Chromium's style guide</a></li>\n<li><code>Mozilla</code>\nA style complying with <a href=\"https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style\">Mozilla's style guide</a></li>\n<li><code>WebKit</code>\nA style complying with <a href=\"http://www.webkit.org/coding/coding-style.html\">WebKit's style guide</a></li>\n</ul>\n",
"options": [
"LLVM",
"Google",
"Chromium",
"Mozilla",
"WebKit"
]
},
"AccessModifierOffset": {
"type": "int",
"doc": "<p> The extra indent or outdent of access modifiers, e.g. <code>public:</code>.</p>\n"
},
"AlignAfterOpenBracket": {
"type": "bool",
"doc": "<p> If <code>true</code>, horizontally aligns arguments after an open bracket.</p>\n<p> This applies to round brackets (parentheses), angle brackets and square\n brackets. This will result in formattings like</p>\n<pre><code class=\"lang- \"> someLongFunction(argument1,\n argument2);\n</code></pre>\n"
},
"AlignEscapedNewlinesLeft": {
"type": "bool",
"doc": "<p> If <code>true</code>, aligns escaped newlines as far left as possible.\n Otherwise puts them into the right-most column.</p>\n"
},
"AlignOperands": {
"type": "bool",
"doc": "<p> If <code>true</code>, horizontally align operands of binary and ternary\n expressions.</p>\n"
},
"AlignTrailingComments": {
"type": "bool",
"doc": "<p> If <code>true</code>, aligns trailing comments.</p>\n"
},
"AllowAllParametersOfDeclarationOnNextLine": {
"type": "bool",
"doc": "<p> Allow putting all parameters of a function declaration onto\n the next line even if <code>BinPackParameters</code> is <code>false</code>.</p>\n"
},
"AllowShortBlocksOnASingleLine": {
"type": "bool",
"doc": "<p> Allows contracting simple braced statements to a single line.</p>\n<p> E.g., this allows <code>if (a) { return; }</code> to be put on a single line.</p>\n"
},
"AllowShortCaseLabelsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, short case labels will be contracted to a single line.</p>\n"
},
"AllowShortFunctionsOnASingleLine": {
"type": "ShortFunctionStyle",
"doc": "<p> Dependent on the value, <code>int f() { return 0; }</code> can be put\n on a single line.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>SFS_None</code> (in configuration: <code>None</code>)\nNever merge functions into a single line.</li>\n<li><code>SFS_Inline</code> (in configuration: <code>Inline</code>)\nOnly merge functions defined inside a class.</li>\n<li><code>SFS_Empty</code> (in configuration: <code>Empty</code>)\nOnly merge empty functions.</li>\n<li><code>SFS_All</code> (in configuration: <code>All</code>)\nMerge all functions fitting on a single line.</li>\n</ul>\n",
"options": [
"None",
"Inline",
"Empty",
"All"
]
},
"AllowShortIfStatementsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, <code>if (a) return;</code> can be put on a single\n line.</p>\n"
},
"AllowShortLoopsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, <code>while (true) continue;</code> can be put on a\n single line.</p>\n"
},
"AlwaysBreakAfterDefinitionReturnType": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break after function definition return types.</p>\n<p> More truthfully called 'break before the identifier following the type\n in a function definition'. PenaltyReturnTypeOnItsOwnLine becomes\n irrelevant.</p>\n"
},
"AlwaysBreakBeforeMultilineStrings": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break before multiline string literals.</p>\n"
},
"AlwaysBreakTemplateDeclarations": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break after the <code>template<...></code> of a\n template declaration.</p>\n"
},
"BinPackArguments": {
"type": "bool",
"doc": "<p> If <code>false</code>, a function call's arguments will either be all on the\n same line or will have one line each.</p>\n"
},
"BinPackParameters": {
"type": "bool",
"doc": "<p> If <code>false</code>, a function declaration's or function definition's\n parameters will either all be on the same line or will have one line each.</p>\n"
},
"BreakBeforeBinaryOperators": {
"type": "BinaryOperatorStyle",
"doc": "<p> The way to wrap binary operators.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>BOS_None</code> (in configuration: <code>None</code>)\nBreak after operators.</li>\n<li><code>BOS_NonAssignment</code> (in configuration: <code>NonAssignment</code>)\nBreak before operators that aren't assignments.</li>\n<li><code>BOS_All</code> (in configuration: <code>All</code>)\nBreak before operators.</li>\n</ul>\n",
"options": [
"None",
"NonAssignment",
"All"
]
},
"BreakBeforeBraces": {
"type": "BraceBreakingStyle",
"doc": "<p> The brace breaking style to use.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>BS_Attach</code> (in configuration: <code>Attach</code>)\nAlways attach braces to surrounding context.</li>\n<li><code>BS_Linux</code> (in configuration: <code>Linux</code>)\nLike <code>Attach</code>, but break before braces on function, namespace and\nclass definitions.</li>\n<li><code>BS_Stroustrup</code> (in configuration: <code>Stroustrup</code>)\nLike <code>Attach</code>, but break before function definitions, and 'else'.</li>\n<li><code>BS_Allman</code> (in configuration: <code>Allman</code>)\nAlways break before braces.</li>\n<li><code>BS_GNU</code> (in configuration: <code>GNU</code>)\nAlways break before braces and add an extra level of indentation to\nbraces of control statements, not to those of class, function\nor other definitions.</li>\n</ul>\n",
"options": [
"Attach",
"Linux",
"Stroustrup",
"Allman",
"GNU"
]
},
"BreakBeforeTernaryOperators": {
"type": "bool",
"doc": "<p> If <code>true</code>, ternary operators will be placed after line breaks.</p>\n"
},
"BreakConstructorInitializersBeforeComma": {
"type": "bool",
"doc": "<p> Always break constructor initializers before commas and align\n the commas with the colon.</p>\n"
},
"ColumnLimit": {
"type": "unsigned",
"doc": "<p> The column limit.</p>\n<p> A column limit of <code>0</code> means that there is no column limit. In this case,\n clang-format will respect the input's line breaking decisions within\n statements unless they contradict other rules.</p>\n"
},
"CommentPragmas": {
"type": "std::string",
"doc": "<p> A regular expression that describes comments with special meaning,\n which should not be split into lines or otherwise changed.</p>\n"
},
"ConstructorInitializerAllOnOneLineOrOnePerLine": {
"type": "bool",
"doc": "<p> If the constructor initializers don't fit on a line, put each\n initializer on its own line.</p>\n"
},
"ConstructorInitializerIndentWidth": {
"type": "unsigned",
"doc": "<p> The number of characters to use for indentation of constructor\n initializer lists.</p>\n"
},
"ContinuationIndentWidth": {
"type": "unsigned",
"doc": "<p> Indent width for line continuations.</p>\n"
},
"Cpp11BracedListStyle": {
"type": "bool",
"doc": "<p> If <code>true</code>, format braced lists as best suited for C++11 braced\n lists.</p>\n<p> Important differences:</p>\n<ul>\n<li>No spaces inside the braced list.</li>\n<li>No line break before the closing brace.</li>\n<li><p>Indentation with the continuation indent, not with the block indent.</p>\n<p>Fundamentally, C++11 braced lists are formatted exactly like function\ncalls would be formatted in their place. If the braced list follows a name\n(e.g. a type or variable name), clang-format formats as if the <code>{}</code> were\nthe parentheses of a function call with that name. If there is no name,\na zero-length name is assumed.</p>\n</li>\n</ul>\n"
},
"DerivePointerAlignment": {
"type": "bool",
"doc": "<p> If <code>true</code>, analyze the formatted file for the most common\n alignment of & and *. <code>PointerAlignment</code> is then used only as fallback.</p>\n"
},
"DisableFormat": {
"type": "bool",
"doc": "<p> Disables formatting at all.</p>\n"
},
"ExperimentalAutoDetectBinPacking": {
"type": "bool",
"doc": "<p> If <code>true</code>, clang-format detects whether function calls and\n definitions are formatted with one parameter per line.</p>\n<p> Each call can be bin-packed, one-per-line or inconclusive. If it is\n inconclusive, e.g. completely on one line, but a decision needs to be\n made, clang-format analyzes whether there are other bin-packed cases in\n the input file and act accordingly.</p>\n<p> NOTE: This is an experimental flag, that might go away or be renamed. Do\n not use this in config files, etc. Use at your own risk.</p>\n"
},
"ForEachMacros": {
"type": "std::vector<std::string>",
"doc": "<p> A vector of macros that should be interpreted as foreach loops\n instead of as function calls.</p>\n<p> These are expected to be macros of the form:</p>\n<pre><code class=\"lang- \"> FOREACH(<variable-declaration>, ...)\n <loop-body>\n</code></pre>\n<p> For example: BOOST_FOREACH.</p>\n"
},
"IndentCaseLabels": {
"type": "bool",
"doc": "<p> Indent case labels one level from the switch statement.</p>\n<p> When <code>false</code>, use the same indentation level as for the switch statement.\n Switch statement body is always indented one level more than case labels.</p>\n"
},
"IndentWidth": {
"type": "unsigned",
"doc": "<p> The number of columns to use for indentation.</p>\n"
},
"IndentWrappedFunctionNames": {
"type": "bool",
"doc": "<p> Indent if a function definition or declaration is wrapped after the\n type.</p>\n"
},
"KeepEmptyLinesAtTheStartOfBlocks": {
"type": "bool",
"doc": "<p> If true, empty lines at the start of blocks are kept.</p>\n"
},
"Language": {
"type": "LanguageKind",
"doc": "<p> Language, this format style is targeted at.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LK_None</code> (in configuration: <code>None</code>)\nDo not use.</li>\n<li><code>LK_Cpp</code> (in configuration: <code>Cpp</code>)\nShould be used for C, C++, ObjectiveC, ObjectiveC++.</li>\n<li><code>LK_Java</code> (in configuration: <code>Java</code>)\nShould be used for Java.</li>\n<li><code>LK_JavaScript</code> (in configuration: <code>JavaScript</code>)\nShould be used for JavaScript.</li>\n<li><code>LK_Proto</code> (in configuration: <code>Proto</code>)\nShould be used for Protocol Buffers\n(https://developers.google.com/protocol-buffers/).</li>\n</ul>\n",
"options": [
"None",
"Cpp",
"Java",
"JavaScript",
"Proto"
]
},
"MaxEmptyLinesToKeep": {
"type": "unsigned",
"doc": "<p> The maximum number of consecutive empty lines to keep.</p>\n"
},
"NamespaceIndentation": {
"type": "NamespaceIndentationKind",
"doc": "<p> The indentation used for namespaces.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>NI_None</code> (in configuration: <code>None</code>)\nDon't indent in namespaces.</li>\n<li><code>NI_Inner</code> (in configuration: <code>Inner</code>)\nIndent only in inner namespaces (nested in other namespaces).</li>\n<li><code>NI_All</code> (in configuration: <code>All</code>)\nIndent in all namespaces.</li>\n</ul>\n",
"options": [
"None",
"Inner",
"All"
]
},
"ObjCBlockIndentWidth": {
"type": "unsigned",
"doc": "<p> The number of characters to use for indentation of ObjC blocks.</p>\n"
},
"ObjCSpaceAfterProperty": {
"type": "bool",
"doc": "<p> Add a space after <code>@property</code> in Objective-C, i.e. use\n <code>\\@property (readonly)</code> instead of <code>\\@property(readonly)</code>.</p>\n"
},
"ObjCSpaceBeforeProtocolList": {
"type": "bool",
"doc": "<p> Add a space in front of an Objective-C protocol list, i.e. use\n <code>Foo <Protocol></code> instead of <code>Foo<Protocol></code>.</p>\n"
},
"PenaltyBreakBeforeFirstCallParameter": {
"type": "unsigned",
"doc": "<p> The penalty for breaking a function call after "call(".</p>\n"
},
"PenaltyBreakComment": {
"type": "unsigned",
"doc": "<p> The penalty for each line break introduced inside a comment.</p>\n"
},
"PenaltyBreakFirstLessLess": {
"type": "unsigned",
"doc": "<p> The penalty for breaking before the first <code><<</code>.</p>\n"
},
"PenaltyBreakString": {
"type": "unsigned",
"doc": "<p> The penalty for each line break introduced inside a string literal.</p>\n"
},
"PenaltyExcessCharacter": {
"type": "unsigned",
"doc": "<p> The penalty for each character outside of the column limit.</p>\n"
},
"PenaltyReturnTypeOnItsOwnLine": {
"type": "unsigned",
"doc": "<p> Penalty for putting the return type of a function onto its own\n line.</p>\n"
},
"PointerAlignment": {
"type": "PointerAlignmentStyle",
"doc": "<p> Pointer and reference alignment style.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>PAS_Left</code> (in configuration: <code>Left</code>)\nAlign pointer to the left.</li>\n<li><code>PAS_Right</code> (in configuration: <code>Right</code>)\nAlign pointer to the right.</li>\n<li><code>PAS_Middle</code> (in configuration: <code>Middle</code>)\nAlign pointer in the middle.</li>\n</ul>\n",
"options": [
"Left",
"Right",
"Middle"
]
},
"SpaceAfterCStyleCast": {
"type": "bool",
"doc": "<p> If <code>true</code>, a space may be inserted after C style casts.</p>\n"
},
"SpaceBeforeAssignmentOperators": {
"type": "bool",
"doc": "<p> If <code>false</code>, spaces will be removed before assignment operators.</p>\n"
},
"SpaceBeforeParens": {
"type": "SpaceBeforeParensOptions",
"doc": "<p> Defines in which cases to put a space before opening parentheses.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>SBPO_Never</code> (in configuration: <code>Never</code>)\nNever put a space before opening parentheses.</li>\n<li><code>SBPO_ControlStatements</code> (in configuration: <code>ControlStatements</code>)\nPut a space before opening parentheses only after control statement\nkeywords (<code>for/if/while...</code>).</li>\n<li><code>SBPO_Always</code> (in configuration: <code>Always</code>)\nAlways put a space before opening parentheses, except when it's\nprohibited by the syntax rules (in function-like macro definitions) or\nwhen determined by other style rules (after unary operators, opening\nparentheses, etc.)</li>\n</ul>\n",
"options": [
"Never",
"ControlStatements",
"Always"
]
},
"SpaceInEmptyParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces may be inserted into '()'.</p>\n"
},
"SpacesBeforeTrailingComments": {
"type": "unsigned",
"doc": "<p> The number of spaces before trailing line comments\n (<code>//</code> - comments).</p>\n<p> This does not affect trailing block comments (<code>/**/</code> - comments) as those\n commonly have different usage patterns and a number of special cases.</p>\n"
},
"SpacesInAngles": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces will be inserted after '<' and before '>' in\n template argument lists</p>\n"
},
"SpacesInCStyleCastParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces may be inserted into C style casts.</p>\n"
},
"SpacesInContainerLiterals": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces are inserted inside container literals (e.g.\n ObjC and Javascript array and dict literals).</p>\n"
},
"SpacesInParentheses": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces will be inserted after '(' and before ')'.</p>\n"
},
"SpacesInSquareBrackets": {
"type": "bool",
"doc": "<p> If <code>true</code>, spaces will be inserted after '[' and before ']'.</p>\n"
},
"Standard": {
"type": "LanguageStandard",
"doc": "<p> Format compatible with this standard, e.g. use\n <code>A<A<int> ></code> instead of <code>A<A<int>></code> for LS_Cpp03.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LS_Cpp03</code> (in configuration: <code>Cpp03</code>)\nUse C++03-compatible syntax.</li>\n<li><code>LS_Cpp11</code> (in configuration: <code>Cpp11</code>)\nUse features of C++11 (e.g. <code>A<A<int>></code> instead of\n<code>A<A<int> ></code>).</li>\n<li><code>LS_Auto</code> (in configuration: <code>Auto</code>)\nAutomatic detection based on the input.</li>\n</ul>\n",
"options": [
"Cpp03",
"Cpp11",
"Auto"
]
},
"TabWidth": {
"type": "unsigned",
"doc": "<p> The number of columns used for tab stops.</p>\n"
},
"UseTab": {
"type": "UseTabStyle",
"doc": "<p> The way to use tab characters in the resulting file.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>UT_Never</code> (in configuration: <code>Never</code>)\nNever use tab.</li>\n<li><code>UT_ForIndentation</code> (in configuration: <code>ForIndentation</code>)\nUse tabs only for indentation.</li>\n<li><code>UT_Always</code> (in configuration: <code>Always</code>)\nUse tabs whenever we need to fill whitespace that spans at least from\none tab stop to the next one.</li>\n</ul>\n",
"options": [
"Never",
"ForIndentation",
"Always"
]
}
},
"3.6.2": {
"BasedOnStyle": {
"type": "string",
"doc": "<p> The style used for all options not specifically set in the configuration.</p>\n<p> This option is supported only in the <strong>clang-format</strong> configuration\n (both within <code>-style='{...}'</code> and the <code>.clang-format</code> file).</p>\n<p> Possible values:</p>\n<ul>\n<li><code>LLVM</code>\nA style complying with the <a href=\"http://llvm.org/docs/CodingStandards.html\">LLVM coding standards</a></li>\n<li><code>Google</code>\nA style complying with <a href=\"http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml\">Google's C++ style guide</a></li>\n<li><code>Chromium</code>\nA style complying with <a href=\"http://www.chromium.org/developers/coding-style\">Chromium's style guide</a></li>\n<li><code>Mozilla</code>\nA style complying with <a href=\"https://developer.mozilla.org/en-US/docs/Developer_Guide/Coding_Style\">Mozilla's style guide</a></li>\n<li><code>WebKit</code>\nA style complying with <a href=\"http://www.webkit.org/coding/coding-style.html\">WebKit's style guide</a></li>\n</ul>\n",
"options": [
"LLVM",
"Google",
"Chromium",
"Mozilla",
"WebKit"
]
},
"AccessModifierOffset": {
"type": "int",
"doc": "<p> The extra indent or outdent of access modifiers, e.g. <code>public:</code>.</p>\n"
},
"AlignAfterOpenBracket": {
"type": "bool",
"doc": "<p> If <code>true</code>, horizontally aligns arguments after an open bracket.</p>\n<p> This applies to round brackets (parentheses), angle brackets and square\n brackets. This will result in formattings like</p>\n<pre><code class=\"lang- \"> someLongFunction(argument1,\n argument2);\n</code></pre>\n"
},
"AlignEscapedNewlinesLeft": {
"type": "bool",
"doc": "<p> If <code>true</code>, aligns escaped newlines as far left as possible.\n Otherwise puts them into the right-most column.</p>\n"
},
"AlignOperands": {
"type": "bool",
"doc": "<p> If <code>true</code>, horizontally align operands of binary and ternary\n expressions.</p>\n"
},
"AlignTrailingComments": {
"type": "bool",
"doc": "<p> If <code>true</code>, aligns trailing comments.</p>\n"
},
"AllowAllParametersOfDeclarationOnNextLine": {
"type": "bool",
"doc": "<p> Allow putting all parameters of a function declaration onto\n the next line even if <code>BinPackParameters</code> is <code>false</code>.</p>\n"
},
"AllowShortBlocksOnASingleLine": {
"type": "bool",
"doc": "<p> Allows contracting simple braced statements to a single line.</p>\n<p> E.g., this allows <code>if (a) { return; }</code> to be put on a single line.</p>\n"
},
"AllowShortCaseLabelsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, short case labels will be contracted to a single line.</p>\n"
},
"AllowShortFunctionsOnASingleLine": {
"type": "ShortFunctionStyle",
"doc": "<p> Dependent on the value, <code>int f() { return 0; }</code> can be put\n on a single line.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>SFS_None</code> (in configuration: <code>None</code>)\nNever merge functions into a single line.</li>\n<li><code>SFS_Inline</code> (in configuration: <code>Inline</code>)\nOnly merge functions defined inside a class.</li>\n<li><code>SFS_Empty</code> (in configuration: <code>Empty</code>)\nOnly merge empty functions.</li>\n<li><code>SFS_All</code> (in configuration: <code>All</code>)\nMerge all functions fitting on a single line.</li>\n</ul>\n",
"options": [
"None",
"Inline",
"Empty",
"All"
]
},
"AllowShortIfStatementsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, <code>if (a) return;</code> can be put on a single\n line.</p>\n"
},
"AllowShortLoopsOnASingleLine": {
"type": "bool",
"doc": "<p> If <code>true</code>, <code>while (true) continue;</code> can be put on a\n single line.</p>\n"
},
"AlwaysBreakAfterDefinitionReturnType": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break after function definition return types.</p>\n<p> More truthfully called 'break before the identifier following the type\n in a function definition'. PenaltyReturnTypeOnItsOwnLine becomes\n irrelevant.</p>\n"
},
"AlwaysBreakBeforeMultilineStrings": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break before multiline string literals.</p>\n"
},
"AlwaysBreakTemplateDeclarations": {
"type": "bool",
"doc": "<p> If <code>true</code>, always break after the <code>template<...></code> of a\n template declaration.</p>\n"
},
"BinPackArguments": {
"type": "bool",
"doc": "<p> If <code>false</code>, a function call's arguments will either be all on the\n same line or will have one line each.</p>\n"
},
"BinPackParameters": {
"type": "bool",
"doc": "<p> If <code>false</code>, a function declaration's or function definition's\n parameters will either all be on the same line or will have one line each.</p>\n"
},
"BreakBeforeBinaryOperators": {
"type": "BinaryOperatorStyle",
"doc": "<p> The way to wrap binary operators.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>BOS_None</code> (in configuration: <code>None</code>)\nBreak after operators.</li>\n<li><code>BOS_NonAssignment</code> (in configuration: <code>NonAssignment</code>)\nBreak before operators that aren't assignments.</li>\n<li><code>BOS_All</code> (in configuration: <code>All</code>)\nBreak before operators.</li>\n</ul>\n",
"options": [
"None",
"NonAssignment",
"All"
]
},
"BreakBeforeBraces": {
"type": "BraceBreakingStyle",
"doc": "<p> The brace breaking style to use.</p>\n<p> Possible values:</p>\n<ul>\n<li><code>BS_Attach</code> (in configuration: <code>Attach</code>)\nAlways attach braces to surrounding context.</li>\n<li><code>BS_Linux</code> (in configuration: <code>Linux</code>)\nLike <code>Attach</code>, but break before braces on function, namespace and\nclass definitions.</li>\n<li><code>BS_Stroustrup</code> (in configuration: <code>Stroustrup</code>)\nLike <code>Attach</code>, but break before function definitions, and 'else'.</li>\n<li><code>BS_Allman</code> (in configuration: <code>Allman</code>)\nAlways break before braces.</li>\n<li><code>BS_GNU</code> (in configuration: <code>GNU</code>)\nAlways break before braces and add an extra level of indentation to\nbraces of control statements, not to those of class, function\nor other definitions.</li>\n</ul>\n",
"options": [
"Attach",
"Linux",
"Stroustrup",
"Allman",
"GNU"
]
},
"BreakBeforeTernaryOperators": {
"type": "bool",
"doc": "<p> If <code>true</code>, ternary operators will be placed after line breaks.</p>\n"
},
"BreakConstructorInitializersBeforeComma": {
"type": "bool",
"doc": "<p> Always break constructor initializers before commas and align\n the commas with the colon.</p>\n"