Skip to content

Commit 228747f

Browse files
authored
Clean up documentation
1 parent 1edc890 commit 228747f

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

clang/include/clang/Format/Format.h

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5143,40 +5143,36 @@ struct FormatStyle {
51435143
/// \version 11
51445144
std::vector<std::string> WhitespaceSensitiveMacros;
51455145

5146-
/// Different styles for modify number of empty lines in
5147-
/// the beginning and at the of end of namespaces.
5146+
/// Different styles for wrapping namespace body with empty lines.
51485147
enum WrapNamespaceBodyWithEmptyLinesStyle : int8_t {
5149-
/// Removes all empty lines at the beginning and at the end of
5150-
/// namespace definition.
5148+
/// Remove all empty lines at the beginning and the end of namespace body.
51515149
/// \code
51525150
/// namespace N1 {
51535151
/// namespace N2
5154-
/// function();
5152+
/// function();
51555153
/// }
51565154
/// }
51575155
/// \endcode
51585156
WNBWELS_Never,
5159-
/// Always adds an empty line at the beginning and at the end of
5160-
/// namespace definition. MaxEmptyLinesToKeep is also applied, but
5161-
/// empty lines between consecutive namespace declarations are
5162-
/// always removed.
5157+
/// Always have at least one empty line at the beginning and the end of
5158+
/// namespace body except that the number of empty lines between consecutive
5159+
/// nested namespace definitions is not increased.
51635160
/// \code
51645161
/// namespace N1 {
51655162
/// namespace N2 {
51665163
///
5167-
/// function();
5164+
/// function();
51685165
///
51695166
/// }
51705167
/// }
51715168
/// \endcode
51725169
WNBWELS_Always,
5173-
/// Keeps existing newlines at the beginning and at the end of
5174-
/// namespace definition using MaxEmptyLinesToKeep for formatting.
5170+
/// Keep existing newlines at the beginning and the end of namespace body.
5171+
/// ``MaxEmptyLinesToKeep`` still applies.
51755172
WNBWELS_Leave
51765173
};
51775174

5178-
/// Controls number of empty lines at the begging and at the end of
5179-
/// namespace definition.
5175+
/// Wrap namespace body with empty lines.
51805176
/// \version 20
51815177
WrapNamespaceBodyWithEmptyLinesStyle WrapNamespaceBodyWithEmptyLines;
51825178

0 commit comments

Comments
 (0)