Skip to content

Commit d42bb16

Browse files
committed
Fix small typo in release notes blurb
1 parent d83b0c0 commit d42bb16

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

clang/docs/ReleaseNotes.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,12 @@ Clang Frontend Potentially Breaking Changes
157157
intended to improve Clang's support for parsing documentation comments and
158158
to better conform to Doxygen's behavior.
159159

160-
This has the potential to cause ``-Wdocumentation`` warnings in cases where
161-
a function-like macro has documentation comment and is followed immediately
162-
by a normal function. The function-like macro's documentation comments will
163-
be attributed to the subsequent function and may cause ``-Wdocumentation``
164-
warnings such as mismatched parameter names, or invalid return documentation
165-
comments.
160+
This has the potential to cause ``-Wdocumentation`` warnings, especially in
161+
cases where a function-like macro has a documentation comment and is followed
162+
immediately by a normal function. The function-like macro's documentation
163+
comments will be attributed to the subsequent function and may cause
164+
``-Wdocumentation`` warnings such as mismatched parameter names, or invalid
165+
return documentation comments.
166166

167167
In cases where the ``-Wdocumentation`` warnings are thrown, the suggested fix
168168
is to document the declaration following the macro so that the warnings are

0 commit comments

Comments
 (0)