diff options
Diffstat (limited to 'lldb/source/Plugins/Process')
20 files changed, 93 insertions, 93 deletions
diff --git a/lldb/source/Plugins/Process/Darwin/DarwinProcessLauncher.h b/lldb/source/Plugins/Process/Darwin/DarwinProcessLauncher.h index 004ff19dd9f..0e65b56a143 100644 --- a/lldb/source/Plugins/Process/Darwin/DarwinProcessLauncher.h +++ b/lldb/source/Plugins/Process/Darwin/DarwinProcessLauncher.h @@ -27,15 +27,15 @@ namespace darwin_process_launcher { // ============================================================================= /// Launches a process for debugging. /// -/// @param[inout] launch_info +/// \param[inout] launch_info /// Specifies details about the process to launch (e.g. path, architecture, /// etc.). On output, includes the launched ProcessID (pid). /// -/// @param[out] pty_master_fd +/// \param[out] pty_master_fd /// Returns the master side of the pseudo-terminal used to communicate /// with stdin/stdout from the launched process. May be nullptr. /// -/// @param[out] launch_flavor +/// \param[out] launch_flavor /// Contains the launch flavor used when launching the process. // ============================================================================= Status diff --git a/lldb/source/Plugins/Process/Darwin/NativeProcessDarwin.h b/lldb/source/Plugins/Process/Darwin/NativeProcessDarwin.h index b55c1728c6a..1b50a8c5cf8 100644 --- a/lldb/source/Plugins/Process/Darwin/NativeProcessDarwin.h +++ b/lldb/source/Plugins/Process/Darwin/NativeProcessDarwin.h @@ -40,7 +40,7 @@ class Scalar; namespace process_darwin { -/// @class NativeProcessDarwin +/// \class NativeProcessDarwin /// Manages communication with the inferior (debugee) process. /// /// Upon construction, this class prepares and launches an inferior process @@ -208,15 +208,15 @@ private: /// listener to the inferior exception port, ptracing the process, and the /// like. /// - /// @param[in] launch_flavor + /// \param[in] launch_flavor /// The launch flavor that was used to launch the process. /// - /// @param[in] main_loop + /// \param[in] main_loop /// The main loop that will run the process monitor. Work /// that needs to be done (e.g. reading files) gets registered /// here along with callbacks to process the work. /// - /// @return + /// \return /// Any error that occurred during the aforementioned /// operations. Failure here will force termination of the /// launched process and debugging session. @@ -317,7 +317,7 @@ private: Status FixupBreakpointPCAsNeeded(NativeThreadDarwin &thread); /// Writes a siginfo_t structure corresponding to the given thread - /// ID to the memory region pointed to by @p siginfo. + /// ID to the memory region pointed to by \p siginfo. Status GetSignalInfo(lldb::tid_t tid, void *siginfo); /// Writes the raw event message code (vis-a-vis PTRACE_GETEVENTMSG) diff --git a/lldb/source/Plugins/Process/Darwin/NativeThreadDarwin.h b/lldb/source/Plugins/Process/Darwin/NativeThreadDarwin.h index 160e18d3589..9f53643ff71 100644 --- a/lldb/source/Plugins/Process/Darwin/NativeThreadDarwin.h +++ b/lldb/source/Plugins/Process/Darwin/NativeThreadDarwin.h @@ -72,11 +72,11 @@ private: // Interface for friend classes // ----------------------------------------------------------------- - /// Resumes the thread. If @p signo is anything but + /// Resumes the thread. If \p signo is anything but /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the thread. Status Resume(uint32_t signo); - /// Single steps the thread. If @p signo is anything but + /// Single steps the thread. If \p signo is anything but /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the thread. Status SingleStep(uint32_t signo); @@ -121,7 +121,7 @@ private: // ------------------------------------------------------------------------- /// Return the mach thread port number for this thread. /// - /// @return + /// \return /// The mach port number for this thread. Returns NULL_THREAD /// when the thread is invalid. // ------------------------------------------------------------------------- diff --git a/lldb/source/Plugins/Process/FreeBSD/POSIXStopInfo.h b/lldb/source/Plugins/Process/FreeBSD/POSIXStopInfo.h index a2fe76714ba..88fb7f31fe0 100644 --- a/lldb/source/Plugins/Process/FreeBSD/POSIXStopInfo.h +++ b/lldb/source/Plugins/Process/FreeBSD/POSIXStopInfo.h @@ -15,7 +15,7 @@ #include <string> //===----------------------------------------------------------------------===// -/// @class POSIXStopInfo +/// \class POSIXStopInfo /// Simple base class for all POSIX-specific StopInfo objects. /// class POSIXStopInfo : public lldb_private::StopInfo { @@ -25,7 +25,7 @@ public: }; //===----------------------------------------------------------------------===// -/// @class POSIXLimboStopInfo +/// \class POSIXLimboStopInfo /// Represents the stop state of a process ready to exit. /// class POSIXLimboStopInfo : public POSIXStopInfo { @@ -44,7 +44,7 @@ public: }; //===----------------------------------------------------------------------===// -/// @class POSIXNewThreadStopInfo +/// \class POSIXNewThreadStopInfo /// Represents the stop state of process when a new thread is spawned. /// diff --git a/lldb/source/Plugins/Process/FreeBSD/ProcessMonitor.cpp b/lldb/source/Plugins/Process/FreeBSD/ProcessMonitor.cpp index dfebbcca283..440b1274e89 100644 --- a/lldb/source/Plugins/Process/FreeBSD/ProcessMonitor.cpp +++ b/lldb/source/Plugins/Process/FreeBSD/ProcessMonitor.cpp @@ -196,7 +196,7 @@ static bool EnsureFDFlags(int fd, int flags, Status &error) { } //------------------------------------------------------------------------------ -/// @class Operation +/// \class Operation /// Represents a ProcessMonitor operation. /// /// Under FreeBSD, it is not possible to ptrace() from any other thread but @@ -214,7 +214,7 @@ public: }; //------------------------------------------------------------------------------ -/// @class ReadOperation +/// \class ReadOperation /// Implements ProcessMonitor::ReadMemory. class ReadOperation : public Operation { public: @@ -240,7 +240,7 @@ void ReadOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class WriteOperation +/// \class WriteOperation /// Implements ProcessMonitor::WriteMemory. class WriteOperation : public Operation { public: @@ -266,7 +266,7 @@ void WriteOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class ReadRegOperation +/// \class ReadRegOperation /// Implements ProcessMonitor::ReadRegisterValue. class ReadRegOperation : public Operation { public: @@ -306,7 +306,7 @@ void ReadRegOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class WriteRegOperation +/// \class WriteRegOperation /// Implements ProcessMonitor::WriteRegisterValue. class WriteRegOperation : public Operation { public: @@ -339,7 +339,7 @@ void WriteRegOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class ReadDebugRegOperation +/// \class ReadDebugRegOperation /// Implements ProcessMonitor::ReadDebugRegisterValue. class ReadDebugRegOperation : public Operation { public: @@ -374,7 +374,7 @@ void ReadDebugRegOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class WriteDebugRegOperation +/// \class WriteDebugRegOperation /// Implements ProcessMonitor::WriteDebugRegisterValue. class WriteDebugRegOperation : public Operation { public: @@ -407,7 +407,7 @@ void WriteDebugRegOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class ReadGPROperation +/// \class ReadGPROperation /// Implements ProcessMonitor::ReadGPR. class ReadGPROperation : public Operation { public: @@ -434,7 +434,7 @@ void ReadGPROperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class ReadFPROperation +/// \class ReadFPROperation /// Implements ProcessMonitor::ReadFPR. class ReadFPROperation : public Operation { public: @@ -457,7 +457,7 @@ void ReadFPROperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class WriteGPROperation +/// \class WriteGPROperation /// Implements ProcessMonitor::WriteGPR. class WriteGPROperation : public Operation { public: @@ -480,7 +480,7 @@ void WriteGPROperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class WriteFPROperation +/// \class WriteFPROperation /// Implements ProcessMonitor::WriteFPR. class WriteFPROperation : public Operation { public: @@ -503,7 +503,7 @@ void WriteFPROperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class ResumeOperation +/// \class ResumeOperation /// Implements ProcessMonitor::Resume. class ResumeOperation : public Operation { public: @@ -534,7 +534,7 @@ void ResumeOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class SingleStepOperation +/// \class SingleStepOperation /// Implements ProcessMonitor::SingleStep. class SingleStepOperation : public Operation { public: @@ -562,7 +562,7 @@ void SingleStepOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class LwpInfoOperation +/// \class LwpInfoOperation /// Implements ProcessMonitor::GetLwpInfo. class LwpInfoOperation : public Operation { public: @@ -591,7 +591,7 @@ void LwpInfoOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class ThreadSuspendOperation +/// \class ThreadSuspendOperation /// Implements ProcessMonitor::ThreadSuspend. class ThreadSuspendOperation : public Operation { public: @@ -611,7 +611,7 @@ void ThreadSuspendOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class EventMessageOperation +/// \class EventMessageOperation /// Implements ProcessMonitor::GetEventMessage. class EventMessageOperation : public Operation { public: @@ -641,7 +641,7 @@ void EventMessageOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class KillOperation +/// \class KillOperation /// Implements ProcessMonitor::Kill. class KillOperation : public Operation { public: @@ -663,7 +663,7 @@ void KillOperation::Execute(ProcessMonitor *monitor) { } //------------------------------------------------------------------------------ -/// @class DetachOperation +/// \class DetachOperation /// Implements ProcessMonitor::Detach. class DetachOperation : public Operation { public: diff --git a/lldb/source/Plugins/Process/FreeBSD/ProcessMonitor.h b/lldb/source/Plugins/Process/FreeBSD/ProcessMonitor.h index 597f741c8a3..cc9c006c506 100644 --- a/lldb/source/Plugins/Process/FreeBSD/ProcessMonitor.h +++ b/lldb/source/Plugins/Process/FreeBSD/ProcessMonitor.h @@ -27,7 +27,7 @@ class Scalar; class ProcessFreeBSD; class Operation; -/// @class ProcessMonitor +/// \class ProcessMonitor /// Manages communication with the inferior (debugee) process. /// /// Upon construction, this class prepares and launches an inferior process @@ -76,14 +76,14 @@ public: /// -1. int GetTerminalFD() const { return m_terminal_fd; } - /// Reads @p size bytes from address @vm_adder in the inferior process + /// Reads \p size bytes from address @vm_adder in the inferior process /// address space. /// /// This method is provided to implement Process::DoReadMemory. size_t ReadMemory(lldb::addr_t vm_addr, void *buf, size_t size, lldb_private::Status &error); - /// Writes @p size bytes from address @p vm_adder in the inferior process + /// Writes \p size bytes from address \p vm_adder in the inferior process /// address space. /// /// This method is provided to implement Process::DoWriteMemory. @@ -151,7 +151,7 @@ public: size_t GetCurrentThreadIDs(std::vector<lldb::tid_t> &thread_ids); /// Writes a ptrace_lwpinfo structure corresponding to the given thread ID - /// to the memory region pointed to by @p lwpinfo. + /// to the memory region pointed to by \p lwpinfo. bool GetLwpInfo(lldb::tid_t tid, void *lwpinfo, int &error_no); /// Suspends or unsuspends a thread prior to process resume or step. @@ -162,11 +162,11 @@ public: /// message. bool GetEventMessage(lldb::tid_t tid, unsigned long *message); - /// Resumes the process. If @p signo is anything but + /// Resumes the process. If \p signo is anything but /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the process. bool Resume(lldb::tid_t unused, uint32_t signo); - /// Single steps the process. If @p signo is anything but + /// Single steps the process. If \p signo is anything but /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the process. bool SingleStep(lldb::tid_t unused, uint32_t signo); @@ -208,7 +208,7 @@ private: lldb_private::Status m_error; // Set if process operation failed. }; - /// @class LauchArgs + /// \class LauchArgs /// /// Simple structure to pass data to the thread responsible for launching a /// child process. diff --git a/lldb/source/Plugins/Process/FreeBSD/RegisterContextPOSIX.h b/lldb/source/Plugins/Process/FreeBSD/RegisterContextPOSIX.h index 085c169b45a..c9bfe0948e9 100644 --- a/lldb/source/Plugins/Process/FreeBSD/RegisterContextPOSIX.h +++ b/lldb/source/Plugins/Process/FreeBSD/RegisterContextPOSIX.h @@ -14,7 +14,7 @@ #include "lldb/Utility/ArchSpec.h" //------------------------------------------------------------------------------ -/// @class POSIXBreakpointProtocol +/// \class POSIXBreakpointProtocol /// /// Extends RegisterClass with a few virtual operations useful on POSIX. class POSIXBreakpointProtocol { @@ -27,7 +27,7 @@ public: /// implementation simply returns true for architectures which do not /// require any update. /// - /// @return + /// \return /// True if the operation succeeded and false otherwise. virtual bool UpdateAfterBreakpoint() = 0; diff --git a/lldb/source/Plugins/Process/Linux/NativeProcessLinux.h b/lldb/source/Plugins/Process/Linux/NativeProcessLinux.h index 184d051fd98..044f16754ff 100644 --- a/lldb/source/Plugins/Process/Linux/NativeProcessLinux.h +++ b/lldb/source/Plugins/Process/Linux/NativeProcessLinux.h @@ -29,7 +29,7 @@ class Status; class Scalar; namespace process_linux { -/// @class NativeProcessLinux +/// \class NativeProcessLinux /// Manages communication with the inferior (debugee) process. /// /// Upon construction, this class prepares and launches an inferior process @@ -182,7 +182,7 @@ private: NativeThreadLinux &AddThread(lldb::tid_t thread_id); /// Writes a siginfo_t structure corresponding to the given thread ID to the - /// memory region pointed to by @p siginfo. + /// memory region pointed to by \p siginfo. Status GetSignalInfo(lldb::tid_t tid, void *siginfo); /// Writes the raw event message code (vis-a-vis PTRACE_GETEVENTMSG) diff --git a/lldb/source/Plugins/Process/Linux/NativeThreadLinux.h b/lldb/source/Plugins/Process/Linux/NativeThreadLinux.h index 84480d36275..e92908baeb5 100644 --- a/lldb/source/Plugins/Process/Linux/NativeThreadLinux.h +++ b/lldb/source/Plugins/Process/Linux/NativeThreadLinux.h @@ -58,11 +58,11 @@ private: // Interface for friend classes // --------------------------------------------------------------------- - /// Resumes the thread. If @p signo is anything but + /// Resumes the thread. If \p signo is anything but /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the thread. Status Resume(uint32_t signo); - /// Single steps the thread. If @p signo is anything but + /// Single steps the thread. If \p signo is anything but /// LLDB_INVALID_SIGNAL_NUMBER, deliver that signal to the thread. Status SingleStep(uint32_t signo); diff --git a/lldb/source/Plugins/Process/Linux/ProcessorTrace.h b/lldb/source/Plugins/Process/Linux/ProcessorTrace.h index 6078141ce77..d105555705c 100644 --- a/lldb/source/Plugins/Process/Linux/ProcessorTrace.h +++ b/lldb/source/Plugins/Process/Linux/ProcessorTrace.h @@ -118,17 +118,17 @@ public: // --------------------------------------------------------------------- /// Read data from a cyclic buffer /// - /// @param[in] [out] buf + /// \param[in] [out] buf /// Destination buffer, the buffer will be truncated to written size. /// - /// @param[in] src + /// \param[in] src /// Source buffer which must be a cyclic buffer. /// - /// @param[in] src_cyc_index + /// \param[in] src_cyc_index /// The index pointer (start of the valid data in the cyclic /// buffer). /// - /// @param[in] offset + /// \param[in] offset /// The offset to begin reading the data in the cyclic buffer. // --------------------------------------------------------------------- static void ReadCyclicBuffer(llvm::MutableArrayRef<uint8_t> &dst, diff --git a/lldb/source/Plugins/Process/NetBSD/NativeProcessNetBSD.h b/lldb/source/Plugins/Process/NetBSD/NativeProcessNetBSD.h index 50c299a74ac..2e7b62d2ae2 100644 --- a/lldb/source/Plugins/Process/NetBSD/NativeProcessNetBSD.h +++ b/lldb/source/Plugins/Process/NetBSD/NativeProcessNetBSD.h @@ -18,7 +18,7 @@ namespace lldb_private { namespace process_netbsd { -/// @class NativeProcessNetBSD +/// \class NativeProcessNetBSD /// Manages communication with the inferior (debugee) process. /// /// Upon construction, this class prepares and launches an inferior process diff --git a/lldb/source/Plugins/Process/POSIX/ProcessMessage.h b/lldb/source/Plugins/Process/POSIX/ProcessMessage.h index c3d8e95a6c4..d9c10caaa95 100644 --- a/lldb/source/Plugins/Process/POSIX/ProcessMessage.h +++ b/lldb/source/Plugins/Process/POSIX/ProcessMessage.h @@ -44,33 +44,33 @@ public: lldb::tid_t GetTID() const { return m_tid; } - /// Indicates that the process @p pid has successfully attached. + /// Indicates that the process \p pid has successfully attached. static ProcessMessage Attach(lldb::pid_t pid) { return ProcessMessage(pid, eAttachMessage); } - /// Indicates that the thread @p tid is about to exit with status @p status. + /// Indicates that the thread \p tid is about to exit with status \p status. static ProcessMessage Limbo(lldb::tid_t tid, int status) { return ProcessMessage(tid, eLimboMessage, status); } - /// Indicates that the thread @p tid had the signal @p signum delivered. + /// Indicates that the thread \p tid had the signal \p signum delivered. static ProcessMessage Signal(lldb::tid_t tid, int signum) { return ProcessMessage(tid, eSignalMessage, signum); } - /// Indicates that a signal @p signum generated by the debugging process was - /// delivered to the thread @p tid. + /// Indicates that a signal \p signum generated by the debugging process was + /// delivered to the thread \p tid. static ProcessMessage SignalDelivered(lldb::tid_t tid, int signum) { return ProcessMessage(tid, eSignalDeliveredMessage, signum); } - /// Indicates that the thread @p tid encountered a trace point. + /// Indicates that the thread \p tid encountered a trace point. static ProcessMessage Trace(lldb::tid_t tid) { return ProcessMessage(tid, eTraceMessage); } - /// Indicates that the thread @p tid encountered a break point. + /// Indicates that the thread \p tid encountered a break point. static ProcessMessage Break(lldb::tid_t tid) { return ProcessMessage(tid, eBreakpointMessage); } @@ -79,7 +79,7 @@ public: return ProcessMessage(tid, eWatchpointMessage, 0, wp_addr); } - /// Indicates that the thread @p tid crashed. + /// Indicates that the thread \p tid crashed. static ProcessMessage Crash(lldb::pid_t pid, CrashReason reason, int signo, lldb::addr_t fault_addr) { ProcessMessage message(pid, eCrashMessage, signo, fault_addr); @@ -87,18 +87,18 @@ public: return message; } - /// Indicates that the thread @p child_tid was spawned. + /// Indicates that the thread \p child_tid was spawned. static ProcessMessage NewThread(lldb::tid_t parent_tid, lldb::tid_t child_tid) { return ProcessMessage(parent_tid, eNewThreadMessage, child_tid); } - /// Indicates that the thread @p tid is about to exit with status @p status. + /// Indicates that the thread \p tid is about to exit with status \p status. static ProcessMessage Exit(lldb::tid_t tid, int status) { return ProcessMessage(tid, eExitMessage, status); } - /// Indicates that the thread @p pid has exec'd. + /// Indicates that the thread \p pid has exec'd. static ProcessMessage Exec(lldb::tid_t tid) { return ProcessMessage(tid, eExecMessage); } diff --git a/lldb/source/Plugins/Process/Utility/HistoryThread.h b/lldb/source/Plugins/Process/Utility/HistoryThread.h index b3c9a4b3d98..cbbb3fc3eef 100644 --- a/lldb/source/Plugins/Process/Utility/HistoryThread.h +++ b/lldb/source/Plugins/Process/Utility/HistoryThread.h @@ -23,7 +23,7 @@ namespace lldb_private { //---------------------------------------------------------------------- -/// @class HistoryThread HistoryThread.h "HistoryThread.h" +/// \class HistoryThread HistoryThread.h "HistoryThread.h" /// A thread object representing a backtrace from a previous point in the /// process execution /// diff --git a/lldb/source/Plugins/Process/Utility/RegisterContextLLDB.h b/lldb/source/Plugins/Process/Utility/RegisterContextLLDB.h index 0b9bee667cb..06100161c73 100644 --- a/lldb/source/Plugins/Process/Utility/RegisterContextLLDB.h +++ b/lldb/source/Plugins/Process/Utility/RegisterContextLLDB.h @@ -116,7 +116,7 @@ private: /// Given a SymbolContext, determines if this is a trap handler function /// aka asynchronous signal handler. /// - /// @return + /// \return /// Returns true if the SymbolContext is a trap handler. //------------------------------------------------------------------ bool IsTrapHandlerSymbol(lldb_private::Process *process, @@ -163,7 +163,7 @@ private: /// better. This is mostly helping to work around problems where the /// assembly language inspection fails on hand-written assembly code. /// - /// @return + /// \return /// Returns true if a fallback unwindplan was found & was installed. //------------------------------------------------------------------ bool TryFallbackUnwindPlan(); diff --git a/lldb/source/Plugins/Process/Utility/RegisterInfoInterface.h b/lldb/source/Plugins/Process/Utility/RegisterInfoInterface.h index 96ea4032996..3d8787515bf 100644 --- a/lldb/source/Plugins/Process/Utility/RegisterInfoInterface.h +++ b/lldb/source/Plugins/Process/Utility/RegisterInfoInterface.h @@ -16,7 +16,7 @@ namespace lldb_private { ///------------------------------------------------------------------------------ -/// @class RegisterInfoInterface +/// \class RegisterInfoInterface /// /// RegisterInfo interface to patch RegisterInfo structure for archs. ///------------------------------------------------------------------------------ diff --git a/lldb/source/Plugins/Process/Utility/UnwindLLDB.h b/lldb/source/Plugins/Process/Utility/UnwindLLDB.h index 4a9cdcaa4a1..808ef947b66 100644 --- a/lldb/source/Plugins/Process/Utility/UnwindLLDB.h +++ b/lldb/source/Plugins/Process/Utility/UnwindLLDB.h @@ -101,7 +101,7 @@ protected: /// into an array of ConstStrings before it can be used - we only want /// to do that once per thread so it's here in the UnwindLLDB object. /// - /// @return + /// \return /// Vector of ConstStrings of trap handler function names. May be /// empty. //------------------------------------------------------------------ diff --git a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteClientBase.h b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteClientBase.h index a2f42b13713..54f69e8caac 100644 --- a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteClientBase.h +++ b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteClientBase.h @@ -27,7 +27,7 @@ public: // ========================================================================= /// Process asynchronously-received structured data. /// - /// @param[in] data + /// \param[in] data /// The complete data packet, expected to start with JSON-async. // ========================================================================= virtual void HandleAsyncStructuredDataPacket(llvm::StringRef data) = 0; diff --git a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h index 84e2c2af747..6cbb44dad99 100644 --- a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h +++ b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h @@ -88,11 +88,11 @@ public: /// Sends a GDB remote protocol 'A' packet that delivers program /// arguments to the remote server. /// - /// @param[in] argv + /// \param[in] argv /// A NULL terminated array of const C strings to use as the /// arguments. /// - /// @return + /// \return /// Zero if the response was "OK", a positive value if the /// the response was "Exx" where xx are two hex digits, or /// -1 if the call is unsupported or any other unexpected @@ -107,11 +107,11 @@ public: /// multiple times in a row in order to pass on the desired /// environment that the inferior should be launched with. /// - /// @param[in] name_equal_value + /// \param[in] name_equal_value /// A NULL terminated C string that contains a single environment /// in the format "NAME=VALUE". /// - /// @return + /// \return /// Zero if the response was "OK", a positive value if the /// the response was "Exx" where xx are two hex digits, or /// -1 if the call is unsupported or any other unexpected @@ -128,15 +128,15 @@ public: //------------------------------------------------------------------ /// Sends a "vAttach:PID" where PID is in hex. /// - /// @param[in] pid + /// \param[in] pid /// A process ID for the remote gdb server to attach to. /// - /// @param[out] response + /// \param[out] response /// The response received from the gdb server. If the return /// value is zero, \a response will contain a stop reply /// packet. /// - /// @return + /// \return /// Zero if the attach was successful, or an error indicating /// an error code. //------------------------------------------------------------------ @@ -146,13 +146,13 @@ public: /// Sends a GDB remote protocol 'I' packet that delivers stdin /// data to the remote process. /// - /// @param[in] data + /// \param[in] data /// A pointer to stdin data. /// - /// @param[in] data_len + /// \param[in] data_len /// The number of bytes available at \a data. /// - /// @return + /// \return /// Zero if the attach was successful, or an error indicating /// an error code. //------------------------------------------------------------------ @@ -162,10 +162,10 @@ public: /// Sets the path to use for stdin/out/err for a process /// that will be launched with the 'A' packet. /// - /// @param[in] path + /// \param[in] path /// The path to use for stdin/out/err /// - /// @return + /// \return /// Zero if the for success, or an error code for failure. //------------------------------------------------------------------ int SetSTDIN(const FileSpec &file_spec); @@ -176,10 +176,10 @@ public: /// Sets the disable ASLR flag to \a enable for a process that will /// be launched with the 'A' packet. /// - /// @param[in] enable + /// \param[in] enable /// A boolean value indicating whether to disable ASLR or not. /// - /// @return + /// \return /// Zero if the for success, or an error code for failure. //------------------------------------------------------------------ int SetDisableASLR(bool enable); @@ -188,10 +188,10 @@ public: /// Sets the DetachOnError flag to \a enable for the process controlled by the /// stub. /// - /// @param[in] enable + /// \param[in] enable /// A boolean value indicating whether to detach on error or not. /// - /// @return + /// \return /// Zero if the for success, or an error code for failure. //------------------------------------------------------------------ int SetDetachOnError(bool enable); @@ -203,10 +203,10 @@ public: /// implements the platform, it will change the current working /// directory for the platform process. /// - /// @param[in] working_dir + /// \param[in] working_dir /// The path to a directory to use when launching our process /// - /// @return + /// \return /// Zero if the for success, or an error code for failure. //------------------------------------------------------------------ int SetWorkingDir(const FileSpec &working_dir); @@ -215,10 +215,10 @@ public: /// Gets the current working directory of a remote platform GDB /// server. /// - /// @param[out] working_dir + /// \param[out] working_dir /// The current working directory on the remote platform. /// - /// @return + /// \return /// Boolean for success //------------------------------------------------------------------ bool GetWorkingDir(FileSpec &working_dir); @@ -462,7 +462,7 @@ public: /// packet. The response is the complete string payload returned /// to the client. /// - /// @return + /// \return /// The string returned by the server to the qSupported query. //------------------------------------------------------------------ const std::string &GetServerSupportedFeatures() const { @@ -485,7 +485,7 @@ public: /// A plugin indicates whether it knows how to handle a type_name. /// If so, it can be used to process the async JSON packet. /// - /// @return + /// \return /// The string returned by the server to the qSupported query. //------------------------------------------------------------------ lldb_private::StructuredData::Array *GetSupportedStructuredDataPlugins(); @@ -493,7 +493,7 @@ public: //------------------------------------------------------------------ /// Configure a StructuredData feature on the remote end. /// - /// @see \b Process::ConfigureStructuredData(...) for details. + /// \see \b Process::ConfigureStructuredData(...) for details. //------------------------------------------------------------------ Status ConfigureRemoteStructuredData(ConstString type_name, diff --git a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerCommon.h b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerCommon.h index c9400687b3b..d0615869d03 100644 --- a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerCommon.h +++ b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerCommon.h @@ -138,7 +138,7 @@ protected: /// server in a situation where the startup code has been provided /// with all the information for a child process to be launched. /// - /// @return + /// \return /// An Status object indicating the success or failure of the /// launch. //------------------------------------------------------------------ diff --git a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerLLGS.h b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerLLGS.h index e26d0591d5e..786910ed93f 100644 --- a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerLLGS.h +++ b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationServerLLGS.h @@ -47,7 +47,7 @@ public: /// server in a situation where the startup code has been provided /// with all the information for a child process to be launched. /// - /// @return + /// \return /// An Status object indicating the success or failure of the /// launch. //------------------------------------------------------------------ @@ -59,7 +59,7 @@ public: /// This method supports attaching llgs to a process accessible via the /// configured Platform. /// - /// @return + /// \return /// An Status object indicating the success or failure of the /// attach operation. //------------------------------------------------------------------ |
