diff options
Diffstat (limited to 'lldb/tools/lldb-vscode/LLDBUtils.h')
| -rw-r--r-- | lldb/tools/lldb-vscode/LLDBUtils.h | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/lldb/tools/lldb-vscode/LLDBUtils.h b/lldb/tools/lldb-vscode/LLDBUtils.h index d063b9e3083..2d7c07f7737 100644 --- a/lldb/tools/lldb-vscode/LLDBUtils.h +++ b/lldb/tools/lldb-vscode/LLDBUtils.h @@ -24,14 +24,14 @@ namespace lldb_vscode { /// All output from every command, including the prompt + the command /// is placed into the "strm" argument. /// -/// @param[in] prefix +/// \param[in] prefix /// A string that will be printed into \a strm prior to emitting /// the prompt + command and command output. Can be NULL. /// -/// @param[in] commands +/// \param[in] commands /// An array of LLDB commands to execute. /// -/// @param[in] strm +/// \param[in] strm /// The stream that will receive the prefix, prompt + command and /// all command output. //---------------------------------------------------------------------- @@ -45,14 +45,14 @@ void RunLLDBCommands(llvm::StringRef prefix, /// All output from every command, including the prompt + the command /// is returned in the std::string return value. /// -/// @param[in] prefix +/// \param[in] prefix /// A string that will be printed into \a strm prior to emitting /// the prompt + command and command output. Can be NULL. /// -/// @param[in] commands +/// \param[in] commands /// An array of LLDB commands to execute. /// -/// @return +/// \return /// A std::string that contains the prefix and all commands and /// command output //---------------------------------------------------------------------- @@ -62,10 +62,10 @@ std::string RunLLDBCommands(llvm::StringRef prefix, ///---------------------------------------------------------------------- /// Check if a thread has a stop reason. /// -/// @param[in] thread +/// \param[in] thread /// The LLDB thread object to check /// -/// @return +/// \return /// \b True if the thread has a valid stop reason, \b false /// otherwise. //---------------------------------------------------------------------- @@ -79,10 +79,10 @@ bool ThreadHasStopReason(lldb::SBThread &thread); /// index in the lower 32 bits and the thread index ID in the upper 32 /// bits. /// -/// @param[in] frame +/// \param[in] frame /// The LLDB stack frame object generate the ID for /// -/// @return +/// \return /// A unique integer that allows us to easily find the right /// stack frame within a thread on subsequent VS code requests. //---------------------------------------------------------------------- @@ -95,10 +95,10 @@ int64_t MakeVSCodeFrameID(lldb::SBFrame &frame); /// index in the lower THREAD_INDEX_SHIFT bits and the thread index ID in /// the upper 32 - THREAD_INDEX_SHIFT bits. /// -/// @param[in] dap_frame_id +/// \param[in] dap_frame_id /// The VSCode frame ID to convert to a thread index ID. /// -/// @return +/// \return /// The LLDB thread index ID. //---------------------------------------------------------------------- uint32_t GetLLDBThreadIndexID(uint64_t dap_frame_id); @@ -110,10 +110,10 @@ uint32_t GetLLDBThreadIndexID(uint64_t dap_frame_id); /// index in the lower THREAD_INDEX_SHIFT bits and the thread index ID in /// the upper 32 - THREAD_INDEX_SHIFT bits. /// -/// @param[in] dap_frame_id +/// \param[in] dap_frame_id /// The VSCode frame ID to convert to a frame ID. /// -/// @return +/// \return /// The LLDB frame index ID. //---------------------------------------------------------------------- uint32_t GetLLDBFrameID(uint64_t dap_frame_id); @@ -126,10 +126,10 @@ uint32_t GetLLDBFrameID(uint64_t dap_frame_id); /// breakpoint ID in the lower BREAKPOINT_ID_SHIFT bits and the /// breakpoint location ID in the upper BREAKPOINT_ID_SHIFT bits. /// -/// @param[in] frame +/// \param[in] frame /// The LLDB stack frame object generate the ID for /// -/// @return +/// \return /// A unique integer that allows us to easily find the right /// stack frame within a thread on subsequent VS code requests. //---------------------------------------------------------------------- @@ -142,10 +142,10 @@ int64_t MakeVSCodeBreakpointID(lldb::SBBreakpointLocation &bp_loc); /// breakpoint ID in the lower BREAKPOINT_ID_SHIFT bits and the /// breakpoint location ID in the upper BREAKPOINT_ID_SHIFT bits. /// -/// @param[in] dap_breakpoint_id +/// \param[in] dap_breakpoint_id /// The VSCode breakpoint ID to convert to an LLDB breakpoint ID. /// -/// @return +/// \return /// The LLDB breakpoint ID. //---------------------------------------------------------------------- uint32_t GetLLDBBreakpointID(uint64_t dap_breakpoint_id); @@ -157,10 +157,10 @@ uint32_t GetLLDBBreakpointID(uint64_t dap_breakpoint_id); /// breakpoint ID in the lower BREAKPOINT_ID_SHIFT bits and the /// breakpoint location ID in the upper BREAKPOINT_ID_SHIFT bits. /// -/// @param[in] dap_breakpoint_id +/// \param[in] dap_breakpoint_id /// The VSCode frame ID to convert to a breakpoint location ID. /// -/// @return +/// \return /// The LLDB breakpoint location ID. //---------------------------------------------------------------------- uint32_t GetLLDBBreakpointLocationID(uint64_t dap_breakpoint_id); |
