[clang] [clang-format] Introduce "ReflowComments: IndentOnly" to re-indent comments without breaking internal structure (think Doxygen). (PR #96804)
Owen Pan via cfe-commits
cfe-commits at lists.llvm.org
Wed Aug 14 18:20:29 PDT 2024
================
@@ -5272,22 +5272,46 @@ the configuration (without a prefix: ``Auto``).
.. _ReflowComments:
-**ReflowComments** (``Boolean``) :versionbadge:`clang-format 3.8` :ref:`¶ <ReflowComments>`
- If ``true``, clang-format will attempt to re-flow comments. That is it
- will touch a comment and *reflow* long comments into new lines, trying to
- obey the ``ColumnLimit``.
+**ReflowComments** (``ReflowCommentsStyle``) :versionbadge:`clang-format 3.8` :ref:`¶ <ReflowComments>`
+ Comment reformatting style.
- .. code-block:: c++
+ Possible values:
+
+ * ``RCS_Never`` (in configuration: ``Never``)
+ Leave comments untouched.
+
+ .. code-block:: c++
+
+ // veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information
+ /* second veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information */
+ /* third veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information
+ * and a misaligned second line */
+
+ * ``RCS_IndentOnly`` (in configuration: ``IndentOnly``)
+ Only apply indentation rules, moving comments left or right, without
+ changing formatting inside the comments.
+
+ .. code-block:: c++
+
+ // veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information
+ /* second veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information */
+ /* third veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLongComment with plenty of information
+ * and a misaligned second line */
+
+ * ``RCS_Always`` (in configuration: ``Always``)
+ Apply indentation rules and re-flow long comments into new lines, trying
----------------
owenca wrote:
You need to rerun `dump_format_style.py` after updating `Format.h`.
https://github.com/llvm/llvm-project/pull/96804
More information about the cfe-commits
mailing list