Skip to content

[NFC][lldb] fix PseudoTerminal documentation #172318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
charles-zablit merged 1 commit into from
Dec 15, 2025
+10 −10
Merged

[NFC][lldb] fix PseudoTerminal documentation #172318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions lldb/include/lldb/Host/PseudoTerminal.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,15 @@ class PseudoTerminal {
invalid_fd = -1 ///< Invalid file descriptor value
};

/// Default constructor
///
/// Constructs this object with invalid primary and secondary file
/// descriptors.
PseudoTerminal();

/// Destructor
/// The destructor will close the primary and secondary file
/// descriptor/HANDLEs if they are valid and ownership has not been released.
///
/// The destructor will close the primary and secondary file descriptors if
/// they are valid and ownership has not been released using one of: @li
/// PseudoTerminal::ReleasePrimaryFileDescriptor() @li
/// PseudoTerminal::ReleaseSaveFileDescriptor()
/// \see PseudoTerminal::ReleasePrimaryFileDescriptor()
/// \see PseudoTerminal::ReleaseSecondaryFileDescriptor()
~PseudoTerminal();

/// Close the primary file descriptor if it is valid.
Expand All @@ -58,14 +55,17 @@ class PseudoTerminal {
/// closed as it is no longer needed by the child process.
///
/// This class will close the file descriptors for the primary/secondary when
/// the destructor is called. The file handles can be released using either:
/// @li PseudoTerminal::ReleasePrimaryFileDescriptor() @li
/// PseudoTerminal::ReleaseSaveFileDescriptor()
/// the destructor is called. The file handles can be released using one of:
/// @li PseudoTerminal::ReleasePrimaryFileDescriptor()
/// @li PseudoTerminal::ReleaseSecondaryFileDescriptor()
///
/// \return
/// \b Parent process: a child process ID that is greater
/// than zero, or an error if the fork fails.
/// \b Child process: zero.
///
/// \see PseudoTerminal::ReleasePrimaryFileDescriptor()
/// \see PseudoTerminal::ReleaseSecondaryFileDescriptor()
llvm::Expected<lldb::pid_t> Fork();

/// The primary file descriptor accessor.
Expand Down
Loading