================
@@ -29,11 +30,31 @@ class PseudoConsole {
   PseudoConsole &operator=(const PseudoConsole &) = delete;
   PseudoConsole &operator=(PseudoConsole &&) = delete;
 
+  /// Creates and opens a new ConPTY instance with a default console size of
+  /// 80x25. Also sets up the associated STDIN/STDOUT pipes and drains any
+  /// initialization sequences emitted by Windows.
+  ///
+  /// \return
+  ///     An llvm::Error if the ConPTY could not be created, or if ConPTY is
+  ///     not available on this version of Windows, llvm::Error::success()
+  ///     otherwise.
   llvm::Error OpenPseudoConsole();
 
-  /// Close the ConPTY, its read/write handles and invalidate them.
+  /// Closes the ConPTY and invalidates its handle, without closing the STDIN
+  /// and STDOUT pipes. Closing the ConPTY signals EOF to any process currently
+  /// attached to it.
   void Close();
 
+  /// Closes the STDIN and STDOUT pipe handles and invalidates them
+  void ClosePipes();
+
+  /// Returns whether the ConPTY and its pipes are currently open and valid.
+  ///
+  /// \return
+  ///     True if the ConPTY handle, STDIN write handle, and STDOUT read handle
+  ///     are all valid, false otherwise.
----------------
Nerixyz wrote:

```suggestion
```

The `\return` repeats what the description already said. I think that's what 
Jonas mentioned in 
https://discourse.llvm.org/t/rfc-policy-for-doxygen-comments/89675.

https://github.com/llvm/llvm-project/pull/182302
_______________________________________________
lldb-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits

Reply via email to