Skip to content

Conversation

jimingham
Copy link
Collaborator

This was causing bot failures if you build with -Werror -Wdocumentation.
Fix the docs to reflect the new headers.

failures if you run with -Werror -Wdocumentation.
Fix the docs to reflect the new headers.
@llvmbot llvmbot added the lldb label Oct 7, 2025
@llvmbot
Copy link
Member

llvmbot commented Oct 7, 2025

@llvm/pr-subscribers-lldb

Author: None (jimingham)

Changes

This was causing bot failures if you build with -Werror -Wdocumentation.
Fix the docs to reflect the new headers.


Full diff: https://github.com/llvm/llvm-project/pull/162401.diff

1 Files Affected:

  • (modified) lldb/include/lldb/Utility/Stream.h (+2-10)
diff --git a/lldb/include/lldb/Utility/Stream.h b/lldb/include/lldb/Utility/Stream.h
index fc547ed739239..82774d56922a9 100644
--- a/lldb/include/lldb/Utility/Stream.h
+++ b/lldb/include/lldb/Utility/Stream.h
@@ -260,16 +260,8 @@ class Stream {
   /// \param[in] text
   ///     The string to be output to the stream.
   ///
-  /// \param[in] pattern
-  ///     The regex pattern to match against the \a text string. Portions of \a
-  ///     text matching this pattern will be colorized. If this parameter is
-  ///     nullptr, highlighting is not performed.
-  /// \param[in] prefix
-  ///     The ANSI color code to start colorization. This is
-  ///     environment-dependent.
-  /// \param[in] suffix
-  ///     The ANSI color code to end colorization. This is
-  ///     environment-dependent.
+  /// \param[in] settings
+  ///     Optional print hilight settings.
   void PutCStringColorHighlighted(
       llvm::StringRef text,
       std::optional<HighlightSettings> settings = std::nullopt);

@jimingham jimingham merged commit bdef80f into llvm:main Oct 8, 2025
11 checks passed
@jimingham jimingham deleted the stream-docs branch October 8, 2025 00:38
svkeerthy pushed a commit that referenced this pull request Oct 9, 2025
This was causing bot failures if you build with -Werror -Wdocumentation.
Fix the docs to reflect the new headers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants