[Lldb-commits] [lldb] [lldb-dap] Updating naming and documentation to follow style guide. (PR #130202)

[John Harrison via lldb-commits]

https://github.com/ashgti created https://github.com/llvm/llvm-project/pull/130202

Updating the naming and adding documentation to better follow the style guide.

>From a0e065631c5cd071ccf371aa647dd206a99b4054 Mon Sep 17 00:00:00 2001
From: John Harrison <harjohn at google.com>
Date: Fri, 7 Mar 2025 00:13:53 +0100
Subject: [PATCH] [lldb-dap] Updating naming and documentation to follow style
 guide.

Updating the naming and adding documentation to better follow the style guide.
---
 lldb/tools/lldb-dap/OutputRedirector.cpp | 6 +++---
 lldb/tools/lldb-dap/OutputRedirector.h   | 8 +++++++-
 2 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/lldb/tools/lldb-dap/OutputRedirector.cpp b/lldb/tools/lldb-dap/OutputRedirector.cpp
index 9ff25ad4149dd..fe278faca87bf 100644
--- a/lldb/tools/lldb-dap/OutputRedirector.cpp
+++ b/lldb/tools/lldb-dap/OutputRedirector.cpp
@@ -38,7 +38,7 @@ Expected<int> OutputRedirector::GetWriteFileDescriptor() {
   return m_fd;
 }
 
-Error OutputRedirector::RedirectTo(std::FILE *fileOverride,
+Error OutputRedirector::RedirectTo(std::FILE *file_override,
                                    std::function<void(StringRef)> callback) {
   assert(m_fd == kInvalidDescriptor && "Output readirector already started.");
   int new_fd[2];
@@ -56,8 +56,8 @@ Error OutputRedirector::RedirectTo(std::FILE *fileOverride,
   int read_fd = new_fd[0];
   m_fd = new_fd[1];
 
-  if (fileOverride) {
-    int override_fd = fileno(fileOverride);
+  if (file_override) {
+    int override_fd = fileno(file_override);
 
     // Backup the FD to restore once redirection is complete.
     m_original_fd = override_fd;
diff --git a/lldb/tools/lldb-dap/OutputRedirector.h b/lldb/tools/lldb-dap/OutputRedirector.h
index 45571c0d5f344..77b1b76ec4d89 100644
--- a/lldb/tools/lldb-dap/OutputRedirector.h
+++ b/lldb/tools/lldb-dap/OutputRedirector.h
@@ -24,10 +24,16 @@ class OutputRedirector {
   /// Creates writable file descriptor that will invoke the given callback on
   /// each write in a background thread.
   ///
+  /// \param[in] file_override
+  ///     Updates the file descriptor to the redirection pipe, if not null.
+  ///
+  /// \param[in] callback
+  ///     A callback invoked when any data is written to the file handle.
+  ///
   /// \return
   ///     \a Error::success if the redirection was set up correctly, or an error
   ///     otherwise.
-  llvm::Error RedirectTo(std::FILE *overrideFile,
+  llvm::Error RedirectTo(std::FILE *file_override,
                          std::function<void(llvm::StringRef)> callback);
 
   llvm::Expected<int> GetWriteFileDescriptor();