Skip to content

Commit 2625ff3

Browse files
authored
MINOR: [C++][Docs] Fix doxygen issue in ree_util.h (apache#46012)
### Rationale for this change clang 19.1.0 or higher now warns (or errors under `-Wdocumentation`) about improper use of the `\par` directive and we have one such instance in our docs in https://github.com/apache/arrow/blob/main/cpp/src/arrow/util/ree_util.h#L395. See https://godbolt.org/z/61Wh5bEs9. ### What changes are included in this PR? Fixed docstring so it reads and renders as the original author likely intended. ### Are these changes tested? Yes. The code in question isn't currently included in any or our rendered documentation so we can't do a preview here in the PR but I have tested this locally. ### Are there any user-facing changes? No. Authored-by: Bryce Mecum <petridish@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
1 parent ca311c1 commit 2625ff3

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

cpp/src/arrow/util/ree_util.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -392,15 +392,17 @@ class RunEndEncodedArraySpan {
392392
/// \warning Avoid calling end() in a loop, as it will recompute the physical
393393
/// length of the array on each call (O(log N) cost per call).
394394
///
395-
/// \par You can write your loops like this instead:
395+
/// You can write your loops like this instead:
396+
///
396397
/// \code
397398
/// for (auto it = array.begin(), end = array.end(); it != end; ++it) {
398399
/// // ...
399400
/// }
400401
/// \endcode
401402
///
402-
/// \par Or this version that does not look like idiomatic C++, but removes
403+
/// Or this version that does not look like idiomatic C++, but removes
403404
/// the need for calling end() completely:
405+
///
404406
/// \code
405407
/// for (auto it = array.begin(); !it.is_end(array); ++it) {
406408
/// // ...

0 commit comments

Comments
 (0)