[Lldb-commits] [lldb] r355841 - Bring Doxygen comment syntax in sync with LLVM coding style.
Adrian Prantl via lldb-commits
lldb-commits at lists.llvm.org
Mon Mar 11 10:09:30 PDT 2019
Modified: lldb/trunk/source/Target/StackFrame.cpp
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Target/StackFrame.cpp?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/source/Target/StackFrame.cpp (original)
+++ lldb/trunk/source/Target/StackFrame.cpp Mon Mar 11 10:09:29 2019
@@ -1452,25 +1452,25 @@ ValueObjectSP GetValueForDereferincingOf
/// Attempt to reconstruct the ValueObject for the address contained in a
/// given register plus an offset.
///
-/// @params [in] frame
+/// \params [in] frame
/// The current stack frame.
///
-/// @params [in] reg
+/// \params [in] reg
/// The register.
///
-/// @params [in] offset
+/// \params [in] offset
/// The offset from the register.
///
-/// @param [in] disassembler
+/// \param [in] disassembler
/// A disassembler containing instructions valid up to the current PC.
///
-/// @param [in] variables
+/// \param [in] variables
/// The variable list from the current frame,
///
-/// @param [in] pc
+/// \param [in] pc
/// The program counter for the instruction considered the 'user'.
///
-/// @return
+/// \return
/// A string describing the base for the ExpressionPath. This could be a
/// variable, a register value, an argument, or a function return value.
/// The ValueObject if found. If valid, it has a valid ExpressionPath.
Modified: lldb/trunk/source/Utility/FileSpec.cpp
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Utility/FileSpec.cpp?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/source/Utility/FileSpec.cpp (original)
+++ lldb/trunk/source/Utility/FileSpec.cpp Mon Mar 11 10:09:29 2019
@@ -101,13 +101,13 @@ namespace {
//------------------------------------------------------------------
/// Safely get a character at the specified index.
///
-/// @param[in] path
+/// \param[in] path
/// A full, partial, or relative path to a file.
///
-/// @param[in] i
+/// \param[in] i
/// An index into path which may or may not be valid.
///
-/// @return
+/// \return
/// The character at index \a i if the index is valid, or 0 if
/// the index is not valid.
//------------------------------------------------------------------
@@ -130,10 +130,10 @@ inline char safeCharAtIndex(const llvm::
/// need normalization since we aren't trying to resolve the path,
/// we are just trying to remove redundant things from the path.
///
-/// @param[in] path
+/// \param[in] path
/// A full, partial, or relative path to a file.
///
-/// @return
+/// \return
/// Returns \b true if the path needs to be normalized.
//------------------------------------------------------------------
bool needsNormalization(const llvm::StringRef &path) {
@@ -531,7 +531,7 @@ bool FileSpec::RemoveLastPathComponent()
/// file (files with a ".c", ".cpp", ".m", ".mm" (many more)
/// extension).
///
-/// @return
+/// \return
/// \b true if the filespec represents an implementation source
/// file, \b false otherwise.
//------------------------------------------------------------------
Modified: lldb/trunk/source/Utility/Status.cpp
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/source/Utility/Status.cpp?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/source/Utility/Status.cpp (original)
+++ lldb/trunk/source/Utility/Status.cpp Mon Mar 11 10:09:29 2019
@@ -273,7 +273,7 @@ void Status::SetErrorString(llvm::String
//------------------------------------------------------------------
/// Set the current error string to a formatted error string.
///
-/// @param format
+/// \param format
/// A printf style format string
//------------------------------------------------------------------
int Status::SetErrorStringWithFormat(const char *format, ...) {
Modified: lldb/trunk/tools/debugserver/source/JSON.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/tools/debugserver/source/JSON.h?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/tools/debugserver/source/JSON.h (original)
+++ lldb/trunk/tools/debugserver/source/JSON.h Mon Mar 11 10:09:29 2019
@@ -206,14 +206,14 @@ public:
// -------------------------------------------------------------------------
/// Return keyed value as bool
///
- /// @param[in] key
+ /// \param[in] key
/// The value of the key to lookup
///
- /// @param[out] value
+ /// \param[out] value
/// The value of the key as a bool. Undefined if the key doesn't
/// exist or if the key is not either true or false.
///
- /// @return
+ /// \return
/// true if the key existed as was a bool value; false otherwise.
/// Note the return value is *not* the value of the bool, use
/// \b value for that.
Modified: lldb/trunk/tools/debugserver/source/JSONGenerator.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/tools/debugserver/source/JSONGenerator.h?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/tools/debugserver/source/JSONGenerator.h (original)
+++ lldb/trunk/tools/debugserver/source/JSONGenerator.h Mon Mar 11 10:09:29 2019
@@ -17,7 +17,7 @@
#include <vector>
//----------------------------------------------------------------------
-/// @class JSONGenerator JSONGenerator.h
+/// \class JSONGenerator JSONGenerator.h
/// A class which can construct structured data for the sole purpose
/// of printing it in JSON format.
///
Modified: lldb/trunk/tools/debugserver/source/MacOSX/DarwinLog/DarwinLogCollector.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/tools/debugserver/source/MacOSX/DarwinLog/DarwinLogCollector.h?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/tools/debugserver/source/MacOSX/DarwinLog/DarwinLogCollector.h (original)
+++ lldb/trunk/tools/debugserver/source/MacOSX/DarwinLog/DarwinLogCollector.h Mon Mar 11 10:09:29 2019
@@ -32,7 +32,7 @@ public:
//------------------------------------------------------------------
/// Return whether the os_log and activity tracing SPI is available.
///
- /// @return \b true if the activity stream support is available,
+ /// \return \b true if the activity stream support is available,
/// \b false otherwise.
//------------------------------------------------------------------
static bool IsSupported();
@@ -41,7 +41,7 @@ public:
/// Return a log function suitable for DNBLog to use as the internal
/// logging function.
///
- /// @return a DNBLog-style logging function if IsSupported() returns
+ /// \return a DNBLog-style logging function if IsSupported() returns
/// true; otherwise, returns nullptr.
//------------------------------------------------------------------
static DNBCallbackLog GetLogFunction();
Modified: lldb/trunk/tools/driver/Driver.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/tools/driver/Driver.h?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/tools/driver/Driver.h (original)
+++ lldb/trunk/tools/driver/Driver.h Mon Mar 11 10:09:29 2019
@@ -38,7 +38,7 @@ public:
/// Runs the main loop.
///
- /// @return The exit code that the process should return.
+ /// \return The exit code that the process should return.
int MainLoop();
lldb::SBError ProcessArgs(const llvm::opt::InputArgList &args, bool &exiting);
Modified: lldb/trunk/tools/intel-features/intel-pt/Decoder.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/tools/intel-features/intel-pt/Decoder.h?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/tools/intel-features/intel-pt/Decoder.h (original)
+++ lldb/trunk/tools/intel-features/intel-pt/Decoder.h Mon Mar 11 10:09:29 2019
@@ -30,7 +30,7 @@
namespace ptdecoder_private {
//----------------------------------------------------------------------
-/// @class Instruction
+/// \class Instruction
/// Represents an assembly instruction containing raw
/// instruction bytes, instruction address along with information
/// regarding execution flow context and Intel(R) Processor Trace
@@ -80,7 +80,7 @@ private:
};
//---------------------------------------------------------------------------
-/// @class InstructionList
+/// \class InstructionList
/// Represents a list of assembly instructions. Each instruction is of
/// type Instruction.
//---------------------------------------------------------------------------
@@ -110,7 +110,7 @@ private:
};
//----------------------------------------------------------------------
-/// @class TraceOptions
+/// \class TraceOptions
/// Provides Intel(R) Processor Trace specific configuration options and
/// other information obtained by decoding and post-processing the trace
/// data. Currently, this information comprises of the total number of
@@ -126,7 +126,7 @@ public:
/// Get total number of assembly instructions obtained after decoding the
/// complete Intel(R) Processor Trace data obtained from LLDB.
///
- /// @return
+ /// \return
/// Total number of instructions.
//------------------------------------------------------------------
uint32_t getInstructionLogSize() const { return m_insn_log_size; }
@@ -134,7 +134,7 @@ public:
//------------------------------------------------------------------
/// Set total number of assembly instructions.
///
- /// @param[in] size
+ /// \param[in] size
/// Value to be set.
//------------------------------------------------------------------
void setInstructionLogSize(uint32_t size) { m_insn_log_size = size; }
@@ -144,7 +144,7 @@ private:
};
//----------------------------------------------------------------------
-/// @class Decoder
+/// \class Decoder
/// This class makes use of Intel(R) Processor Trace hardware feature
/// (implememted inside LLDB) to gather trace data for an inferior (being
/// debugged with LLDB) to provide meaningful information out of it.
Modified: lldb/trunk/tools/intel-features/intel-pt/PTDecoder.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/tools/intel-features/intel-pt/PTDecoder.h?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/tools/intel-features/intel-pt/PTDecoder.h (original)
+++ lldb/trunk/tools/intel-features/intel-pt/PTDecoder.h Mon Mar 11 10:09:29 2019
@@ -30,7 +30,7 @@ class Decoder;
namespace ptdecoder {
//----------------------------------------------------------------------
-/// @class PTInstruction
+/// \class PTInstruction
/// Represents an assembly instruction containing raw
/// instruction bytes, instruction address along with information
/// regarding execution flow context and Intel(R) Processor Trace
@@ -52,18 +52,18 @@ public:
//------------------------------------------------------------------
/// Get raw bytes of the instruction in the buffer.
///
- /// @param[out] buf
+ /// \param[out] buf
/// The buffer where the raw bytes will be written. This buffer should be
/// allocated by the caller of this API. Providing an unallocated buffer
/// is an error. In case of errors, the content of the buffer is not
/// valid.
///
- /// @param[in] size
+ /// \param[in] size
/// Number of raw bytes to be written to @buf. Atleast @size bytes of
/// memory should be allocated to @buf otherwise the behaviour of the API
/// is undefined. Providing 0 for this argument is an error.
///
- /// @return
+ /// \return
/// Number of bytes of the instruction actually written to @buf if API
/// succeeds. In case of errors, total number of raw bytes of the
/// instruction is returned.
@@ -82,7 +82,7 @@ private:
};
//---------------------------------------------------------------------------
-/// @class PTInstructionList
+/// \class PTInstructionList
/// Represents a list of assembly instructions. Each instruction is of
/// type PTInstruction.
//---------------------------------------------------------------------------
@@ -111,7 +111,7 @@ private:
};
//----------------------------------------------------------------------
-/// @class PTTraceOptions
+/// \class PTTraceOptions
/// Provides configuration options like trace type, trace buffer size,
/// meta data buffer size along with other Intel(R) Processor Trace
/// specific options.
@@ -137,7 +137,7 @@ public:
/// 64-bit unsigned integer in hex format. For "Name", please refer to
/// SBProcess::StartTrace API description for setting SBTraceOptions.
///
- /// @return
+ /// \return
/// A string formatted as json text {"Name":Value,"Name":Value}
//------------------------------------------------------------------
lldb::SBStructuredData GetTraceParams(lldb::SBError &error);
@@ -151,7 +151,7 @@ private:
};
//----------------------------------------------------------------------
-/// @class PTDecoder
+/// \class PTDecoder
/// This class makes use of Intel(R) Processor Trace hardware feature
/// (implememted inside LLDB) to gather trace data for an inferior (being
/// debugged with LLDB) to provide meaningful information out of it.
@@ -176,11 +176,11 @@ public:
/// Start Intel(R) Processor Trace on a thread or complete process with
/// Intel(R) Processor Trace specific configuration options
///
- /// @param[in] sbprocess
+ /// \param[in] sbprocess
/// A valid process on which this operation will be performed. An error is
/// returned in case of an invalid process.
///
- /// @param[in] sbtraceoptions
+ /// \param[in] sbtraceoptions
/// Contains thread id information and configuration options:
///
/// For tracing a single thread, provide a valid thread id. If sbprocess
@@ -209,7 +209,7 @@ public:
/// be started by user. The actual used configuration options can be
/// obtained from GetProcessorTraceInfo() API.
///
- /// @param[out] sberror
+ /// \param[out] sberror
/// An error with the failure reason if API fails. Else success.
//------------------------------------------------------------------
void StartProcessorTrace(lldb::SBProcess &sbprocess,
@@ -219,17 +219,17 @@ public:
//------------------------------------------------------------------
/// Stop Intel(R) Processor Trace on a thread or complete process.
///
- /// @param[in] sbprocess
+ /// \param[in] sbprocess
/// A valid process on which this operation will be performed. An error is
/// returned in case of an invalid process.
///
- /// @param[in] tid
+ /// \param[in] tid
/// Case 1: To stop tracing a single thread, provide a valid thread id. If
/// sbprocess doesn't contain the thread tid, error will be returned.
/// Case 2: To stop tracing complete process, use
/// lldb::LLDB_INVALID_THREAD_ID.
///
- /// @param[out] sberror
+ /// \param[out] sberror
/// An error with the failure reason if API fails. Else success.
//------------------------------------------------------------------
void StopProcessorTrace(lldb::SBProcess &sbprocess, lldb::SBError &sberror,
@@ -239,15 +239,15 @@ public:
/// Get instruction log containing the execution flow for a thread of a
/// process in terms of assembly instructions executed.
///
- /// @param[in] sbprocess
+ /// \param[in] sbprocess
/// A valid process on which this operation will be performed. An error is
/// returned in case of an invalid process.
///
- /// @param[in] tid
+ /// \param[in] tid
/// A valid thread id of the thread for which instruction log is desired.
/// If sbprocess doesn't contain the thread tid, error will be returned.
///
- /// @param[in] count
+ /// \param[in] count
/// The number of instructions requested by the user to be returned from
/// the complete instruction log. Complete instruction log refers to all
/// the assembly instructions obtained after decoding the complete raw
@@ -257,17 +257,17 @@ public:
/// The number of instructions actually returned are dependent on 'count'
/// and 'offset' parameters of this API.
///
- /// @param[in] offset
+ /// \param[in] offset
/// The offset in the complete instruction log from where 'count' number
/// of instructions are requested by the user. offset is counted from the
/// end of of this complete instruction log (which means the last executed
/// instruction is at offset 0 (zero)).
///
- /// @param[out] result_list
+ /// \param[out] result_list
/// Depending upon 'count' and 'offset' values, list will be overwritten
/// with the new instructions.
///
- /// @param[out] sberror
+ /// \param[out] sberror
/// An error with the failure reason if API fails. Else success.
//------------------------------------------------------------------
void GetInstructionLogAtOffset(lldb::SBProcess &sbprocess, lldb::tid_t tid,
@@ -280,21 +280,21 @@ public:
/// process. The information contains the actual configuration options with
/// which the trace was started for this thread.
///
- /// @param[in] sbprocess
+ /// \param[in] sbprocess
/// A valid process on which this operation will be performed. An error is
/// returned in case of an invalid process.
///
- /// @param[in] tid
+ /// \param[in] tid
/// A valid thread id of the thread for which the trace specific
/// information is required. If sbprocess doesn't contain the thread tid,
/// an error will be returned.
///
- /// @param[out] options
+ /// \param[out] options
/// Contains actual configuration options (they may be different to the
/// ones with which tracing was asked to be started for this thread during
/// StartProcessorTrace() API call).
///
- /// @param[out] sberror
+ /// \param[out] sberror
/// An error with the failure reason if API fails. Else success.
//------------------------------------------------------------------
void GetProcessorTraceInfo(lldb::SBProcess &sbprocess, lldb::tid_t tid,
Modified: lldb/trunk/tools/lldb-vscode/JSONUtils.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/tools/lldb-vscode/JSONUtils.h?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/tools/lldb-vscode/JSONUtils.h (original)
+++ lldb/trunk/tools/lldb-vscode/JSONUtils.h Mon Mar 11 10:09:29 2019
@@ -21,13 +21,13 @@ namespace lldb_vscode {
/// string is valid UTF8. If not, first call llvm::json::fixUTF8
/// before emplacing.
///
-/// @param[in] obj
+/// \param[in] obj
/// A JSON object that we will attempt to emplace the value in
///
-/// @param[in] key
+/// \param[in] key
/// The key to use when emplacing the value
///
-/// @param[in] str
+/// \param[in] str
/// The string to emplace
//------------------------------------------------------------------
void EmplaceSafeString(llvm::json::Object &obj, llvm::StringRef key,
@@ -36,10 +36,10 @@ void EmplaceSafeString(llvm::json::Objec
//------------------------------------------------------------------
/// Extract simple values as a string.
///
-/// @param[in] value
+/// \param[in] value
/// A JSON value to extract the string from.
///
-/// @return
+/// \return
/// A llvm::StringRef that contains the string value, or an empty
/// string if \a value isn't a string.
//------------------------------------------------------------------
@@ -49,13 +49,13 @@ llvm::StringRef GetAsString(const llvm::
/// Extract the string value for the specified key from the
/// specified object.
///
-/// @param[in] obj
+/// \param[in] obj
/// A JSON object that we will attempt to extract the value from
///
-/// @param[in] key
+/// \param[in] key
/// The key to use when extracting the value
///
-/// @return
+/// \return
/// A llvm::StringRef that contains the string value for the
/// specified \a key, or an empty string if there is no key that
/// matches or if the value is not a string.
@@ -67,13 +67,13 @@ llvm::StringRef GetString(const llvm::js
/// Extract the unsigned integer value for the specified key from
/// the specified object.
///
-/// @param[in] obj
+/// \param[in] obj
/// A JSON object that we will attempt to extract the value from
///
-/// @param[in] key
+/// \param[in] key
/// The key to use when extracting the value
///
-/// @return
+/// \return
/// The unsigned integer value for the specified \a key, or
/// \a fail_value if there is no key that matches or if the
/// value is not an integer.
@@ -87,13 +87,13 @@ uint64_t GetUnsigned(const llvm::json::O
/// Extract the boolean value for the specified key from the
/// specified object.
///
-/// @param[in] obj
+/// \param[in] obj
/// A JSON object that we will attempt to extract the value from
///
-/// @param[in] key
+/// \param[in] key
/// The key to use when extracting the value
///
-/// @return
+/// \return
/// The boolean value for the specified \a key, or \a fail_value
/// if there is no key that matches or if the value is not a
/// boolean value of an integer.
@@ -107,13 +107,13 @@ bool GetBoolean(const llvm::json::Object
/// Extract the signed integer for the specified key from the
/// specified object.
///
-/// @param[in] obj
+/// \param[in] obj
/// A JSON object that we will attempt to extract the value from
///
-/// @param[in] key
+/// \param[in] key
/// The key to use when extracting the value
///
-/// @return
+/// \return
/// The signed integer value for the specified \a key, or
/// \a fail_value if there is no key that matches or if the
/// value is not an integer.
@@ -126,13 +126,13 @@ int64_t GetSigned(const llvm::json::Obje
//------------------------------------------------------------------
/// Check if the specified key exists in the specified object.
///
-/// @param[in] obj
+/// \param[in] obj
/// A JSON object that we will attempt to extract the value from
///
-/// @param[in] key
+/// \param[in] key
/// The key to check for
///
-/// @return
+/// \return
/// \b True if the key exists in the \a obj, \b False otherwise.
//------------------------------------------------------------------
bool ObjectContainsKey(const llvm::json::Object &obj, llvm::StringRef key);
@@ -145,13 +145,13 @@ bool ObjectContainsKey(const llvm::json:
/// strings. Any NULL, array or objects values in the array will be
/// ignored.
///
-/// @param[in] obj
+/// \param[in] obj
/// A JSON object that we will attempt to extract the array from
///
-/// @param[in] key
+/// \param[in] key
/// The key to use when extracting the value
///
-/// @return
+/// \return
/// An array of string values for the specified \a key, or
/// \a fail_value if there is no key that matches or if the
/// value is not an array or all items in the array are not
@@ -168,10 +168,10 @@ std::vector<std::string> GetStrings(cons
/// \a request, "command" set to the "command" from \a request,
/// and "success" set to true.
///
-/// @param[in] request
+/// \param[in] request
/// The request object received from a call to VSCode::ReadJSON().
///
-/// @param[in,out] response
+/// \param[in,out] response
/// An empty llvm::json::Object object that will be filled
/// in as noted in description.
//------------------------------------------------------------------
@@ -190,15 +190,15 @@ void FillResponse(const llvm::json::Obje
/// the address of the type if it has an address.
///
///
-/// @param[in] v
+/// \param[in] v
/// A lldb::SBValue object to extract the string value from
///
///
-/// @param[in] object
+/// \param[in] object
/// The object to place the value object into
///
///
-/// @param[in] key
+/// \param[in] key
/// The key name to use when inserting the value object we create
//----------------------------------------------------------------------
void SetValueForKey(lldb::SBValue &v, llvm::json::Object &object,
@@ -208,11 +208,11 @@ void SetValueForKey(lldb::SBValue &v, ll
/// Converts \a bp to a JSON value and appends all locations to the
/// \a breakpoints array.
///
-/// @param[in] bp
+/// \param[in] bp
/// A LLDB breakpoint object which will get all locations extracted
/// and converted into a JSON objects in the \a breakpoints array
///
-/// @param[in] breakpoints
+/// \param[in] breakpoints
/// A JSON array that will get a llvm::json::Value for \a bp
/// appended to it.
//----------------------------------------------------------------------
@@ -222,10 +222,10 @@ void AppendBreakpoint(lldb::SBBreakpoint
/// Converts breakpoint location to a Visual Studio Code "Breakpoint"
/// JSON object and appends it to the \a breakpoints array.
///
-/// @param[in] bp_loc
+/// \param[in] bp_loc
/// A LLDB breakpoint location object to convert into a JSON value
///
-/// @return
+/// \return
/// A "Breakpoint" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -234,10 +234,10 @@ llvm::json::Value CreateBreakpoint(lldb:
//----------------------------------------------------------------------
/// Create a "Event" JSON object using \a event_name as the event name
///
-/// @param[in] event_name
+/// \param[in] event_name
/// The string value to use for the "event" key in the JSON object.
///
-/// @return
+/// \return
/// A "Event" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -247,10 +247,10 @@ llvm::json::Object CreateEventObject(con
/// Create a "ExceptionBreakpointsFilter" JSON object as described in
/// the Visual Studio Code debug adaptor definition.
///
-/// @param[in] bp
+/// \param[in] bp
/// The exception breakppoint object to use
///
-/// @return
+/// \return
/// A "ExceptionBreakpointsFilter" JSON object with that follows
/// the formal JSON definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -261,19 +261,19 @@ CreateExceptionBreakpointFilter(const Ex
/// Create a "Scope" JSON object as described in the Visual Studio Code
/// debug adaptor definition.
///
-/// @param[in] name
+/// \param[in] name
/// The value to place into the "name" key
//
-/// @param[in] variablesReference
+/// \param[in] variablesReference
/// The value to place into the "variablesReference" key
//
-/// @param[in] namedVariables
+/// \param[in] namedVariables
/// The value to place into the "namedVariables" key
//
-/// @param[in] expensive
+/// \param[in] expensive
/// The value to place into the "expensive" key
///
-/// @return
+/// \return
/// A "Scope" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -285,11 +285,11 @@ llvm::json::Value CreateScope(const llvm
/// Create a "Source" JSON object as described in the Visual Studio Code
/// debug adaptor definition.
///
-/// @param[in] line_entry
+/// \param[in] line_entry
/// The LLDB line table to use when populating out the "Source"
/// object
///
-/// @return
+/// \return
/// A "Source" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -308,15 +308,15 @@ llvm::json::Value CreateSource(lldb::SBL
/// within the source referred to by "sourceReference" will be filled
/// in.
///
-/// @param[in] frame
+/// \param[in] frame
/// The LLDB stack frame to use when populating out the "Source"
/// object.
///
-/// @param[out] disasm_line
+/// \param[out] disasm_line
/// The line within the "sourceReference" file that the PC from
/// \a frame matches.
///
-/// @return
+/// \return
/// A "Source" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -333,11 +333,11 @@ llvm::json::Value CreateSource(lldb::SBF
/// "line" - the source file line number as an integer
/// "column" - the source file column number as an integer
///
-/// @param[in] frame
+/// \param[in] frame
/// The LLDB stack frame to use when populating out the "StackFrame"
/// object.
///
-/// @return
+/// \return
/// A "StackFrame" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -353,11 +353,11 @@ llvm::json::Value CreateStackFrame(lldb:
/// thread index ID along with the string name of the thread
/// from the OS if it has a name.
///
-/// @param[in] thread
+/// \param[in] thread
/// The LLDB thread to use when populating out the "Thread"
/// object.
///
-/// @return
+/// \return
/// A "Thread" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -378,11 +378,11 @@ llvm::json::Value CreateThread(lldb::SBT
/// "allThreadsStopped" - set to True to indicate that all threads
/// stop when any thread stops.
///
-/// @param[in] thread
+/// \param[in] thread
/// The LLDB thread to use when populating out the "StoppedEvent"
/// object.
///
-/// @return
+/// \return
/// A "StoppedEvent" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
@@ -407,25 +407,25 @@ llvm::json::Value CreateThreadStopped(ll
/// "evaluateName" - The name of the variable to use in expressions
/// as a string.
///
-/// @param[in] v
+/// \param[in] v
/// The LLDB value to use when populating out the "Variable"
/// object.
///
-/// @param[in] variablesReference
+/// \param[in] variablesReference
/// The variable reference. Zero if this value isn't structured
/// and has no children, non-zero if it does have children and
/// might be asked to expand itself.
///
-/// @param[in] varID
+/// \param[in] varID
/// A unique variable identifier to help in properly identifying
/// variables with the same name. This is an extension to the
/// VS protocol.
///
-/// @param[in] format_hex
+/// \param[in] format_hex
/// It set to true the variable will be formatted as hex in
/// the "value" key value pair for the value of the variable.
///
-/// @return
+/// \return
/// A "Variable" JSON object with that follows the formal JSON
/// definition outlined by Microsoft.
//----------------------------------------------------------------------
Modified: lldb/trunk/tools/lldb-vscode/LLDBUtils.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/tools/lldb-vscode/LLDBUtils.h?rev=355841&r1=355840&r2=355841&view=diff
==============================================================================
--- lldb/trunk/tools/lldb-vscode/LLDBUtils.h (original)
+++ lldb/trunk/tools/lldb-vscode/LLDBUtils.h Mon Mar 11 10:09:29 2019
@@ -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 pre
/// 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::String
///----------------------------------------------------------------------
/// 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
/// 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
/// 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 d
/// 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_fra
/// 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::SBB
/// 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 da
/// 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);
More information about the lldb-commits
mailing list