MyDeveloperDay created this revision.
MyDeveloperDay added reviewers: mitchell-stellar, klimek, sammccall, owenpan.
MyDeveloperDay added projects: clang, clang-format.
Format.h is used to generate ClangFormatStyleOptions.rst, the layout of the
comments is critical to the rst file. Accidentally clang-formatting Format.h
can lead to the .rst changing.
This revision simply add // clang-format off/on statement around the areas who
formatting needs to be maintained, mainly around the options that are related
to what happens when the line breaks due to `ColumnLimit` (which is what is
happening to the comment)
This allows Format.h to be clang-formatted without causing a change in the
documentation when dump_format_style.py is rerun, which is also part of the
revision.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D69951
Files:
clang/include/clang/Format/Format.h
Index: clang/include/clang/Format/Format.h
===================================================================
--- clang/include/clang/Format/Format.h
+++ clang/include/clang/Format/Format.h
@@ -1161,6 +1161,7 @@
/// \endcode
bool CompactNamespaces;
+ // clang-format off
/// If the constructor initializers don't fit on a line, put each
/// initializer on its own line.
/// \code
@@ -1178,6 +1179,7 @@
/// }
/// \endcode
bool ConstructorInitializerAllOnOneLineOrOnePerLine;
+ // clang-format on
/// The number of characters to use for indentation of constructor
/// initializer lists as well as inheritance lists.
@@ -1304,6 +1306,7 @@
tooling::IncludeStyle IncludeStyle;
+ // clang-format off
/// Indent case labels one level from the switch statement.
///
/// When ``false``, use the same indentation level as for the switch
statement.
@@ -1319,6 +1322,7 @@
/// } }
/// \endcode
bool IndentCaseLabels;
+ // clang-format on
/// Indent goto labels.
///
@@ -1453,6 +1457,7 @@
/// The JavaScriptQuoteStyle to use for JavaScript strings.
JavaScriptQuoteStyle JavaScriptQuotes;
+ // clang-format off
/// Whether to wrap JavaScript import/export statements.
/// \code{.js}
/// true:
@@ -1466,6 +1471,7 @@
/// import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,
VeryLongImportsAreAnnoying,} from "some/module.js"
/// \endcode
bool JavaScriptWrapImports;
+ // clang-format on
/// If true, the empty line at the start of blocks is kept.
/// \code
@@ -1747,6 +1753,7 @@
/// \endcode
std::vector<RawStringFormat> RawStringFormats;
+ // clang-format off
/// If ``true``, clang-format will attempt to re-flow comments.
/// \code
/// false:
@@ -1760,6 +1767,7 @@
/// * information */
/// \endcode
bool ReflowComments;
+ // clang-format on
/// If ``true``, clang-format will sort ``#includes``.
/// \code
@@ -2294,8 +2302,7 @@
/// a non-recoverable syntax error.
tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
ArrayRef<tooling::Range> Ranges,
- StringRef FileName,
- bool *IncompleteFormat);
+ StringRef FileName, bool *IncompleteFormat);
/// Clean up any erroneous/redundant code in the given \p Ranges in \p
/// Code.
@@ -2406,6 +2413,6 @@
namespace std {
template <>
struct is_error_code_enum<clang::format::ParseError> : std::true_type {};
-}
+} // namespace std
#endif // LLVM_CLANG_FORMAT_FORMAT_H
Index: clang/include/clang/Format/Format.h
===================================================================
--- clang/include/clang/Format/Format.h
+++ clang/include/clang/Format/Format.h
@@ -1161,6 +1161,7 @@
/// \endcode
bool CompactNamespaces;
+ // clang-format off
/// If the constructor initializers don't fit on a line, put each
/// initializer on its own line.
/// \code
@@ -1178,6 +1179,7 @@
/// }
/// \endcode
bool ConstructorInitializerAllOnOneLineOrOnePerLine;
+ // clang-format on
/// The number of characters to use for indentation of constructor
/// initializer lists as well as inheritance lists.
@@ -1304,6 +1306,7 @@
tooling::IncludeStyle IncludeStyle;
+ // clang-format off
/// Indent case labels one level from the switch statement.
///
/// When ``false``, use the same indentation level as for the switch statement.
@@ -1319,6 +1322,7 @@
/// } }
/// \endcode
bool IndentCaseLabels;
+ // clang-format on
/// Indent goto labels.
///
@@ -1453,6 +1457,7 @@
/// The JavaScriptQuoteStyle to use for JavaScript strings.
JavaScriptQuoteStyle JavaScriptQuotes;
+ // clang-format off
/// Whether to wrap JavaScript import/export statements.
/// \code{.js}
/// true:
@@ -1466,6 +1471,7 @@
/// import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,} from "some/module.js"
/// \endcode
bool JavaScriptWrapImports;
+ // clang-format on
/// If true, the empty line at the start of blocks is kept.
/// \code
@@ -1747,6 +1753,7 @@
/// \endcode
std::vector<RawStringFormat> RawStringFormats;
+ // clang-format off
/// If ``true``, clang-format will attempt to re-flow comments.
/// \code
/// false:
@@ -1760,6 +1767,7 @@
/// * information */
/// \endcode
bool ReflowComments;
+ // clang-format on
/// If ``true``, clang-format will sort ``#includes``.
/// \code
@@ -2294,8 +2302,7 @@
/// a non-recoverable syntax error.
tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
ArrayRef<tooling::Range> Ranges,
- StringRef FileName,
- bool *IncompleteFormat);
+ StringRef FileName, bool *IncompleteFormat);
/// Clean up any erroneous/redundant code in the given \p Ranges in \p
/// Code.
@@ -2406,6 +2413,6 @@
namespace std {
template <>
struct is_error_code_enum<clang::format::ParseError> : std::true_type {};
-}
+} // namespace std
#endif // LLVM_CLANG_FORMAT_FORMAT_H
_______________________________________________
cfe-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
