[Lldb-commits] [lldb] ad88277 - [LLDB] Fix a bunch of -Wdocumentation warnings
Jonas Devlieghere via lldb-commits
lldb-commits at lists.llvm.org
Wed Nov 13 12:28:16 PST 2019
Author: Jonas Devlieghere
Date: 2019-11-13T12:28:10-08:00
New Revision: ad882774fe4ee9b37ffcf35d86303c265bbc585a
URL: https://github.com/llvm/llvm-project/commit/ad882774fe4ee9b37ffcf35d86303c265bbc585a
DIFF: https://github.com/llvm/llvm-project/commit/ad882774fe4ee9b37ffcf35d86303c265bbc585a.diff
LOG: [LLDB] Fix a bunch of -Wdocumentation warnings
Added:
Modified:
lldb/include/lldb/Breakpoint/Breakpoint.h
lldb/include/lldb/Breakpoint/BreakpointID.h
lldb/include/lldb/Breakpoint/BreakpointList.h
lldb/include/lldb/Breakpoint/BreakpointLocation.h
lldb/include/lldb/Breakpoint/BreakpointLocationCollection.h
lldb/include/lldb/Breakpoint/BreakpointLocationList.h
lldb/include/lldb/Breakpoint/BreakpointResolver.h
lldb/include/lldb/Breakpoint/BreakpointSite.h
lldb/include/lldb/Breakpoint/Watchpoint.h
lldb/include/lldb/Breakpoint/WatchpointList.h
lldb/include/lldb/Core/Address.h
lldb/include/lldb/Core/AddressRange.h
lldb/include/lldb/Core/Highlighter.h
lldb/include/lldb/Core/Mangled.h
lldb/include/lldb/Core/Module.h
lldb/include/lldb/Core/ModuleChild.h
lldb/include/lldb/Core/ModuleList.h
lldb/include/lldb/Core/SearchFilter.h
lldb/include/lldb/Expression/DWARFExpression.h
lldb/include/lldb/Expression/FunctionCaller.h
lldb/include/lldb/Expression/IRExecutionUnit.h
lldb/include/lldb/Expression/REPL.h
lldb/include/lldb/Expression/UserExpression.h
lldb/include/lldb/Host/File.h
lldb/include/lldb/Host/HostInfoBase.h
lldb/include/lldb/Host/HostProcess.h
lldb/include/lldb/Host/PseudoTerminal.h
lldb/include/lldb/Interpreter/CommandInterpreter.h
lldb/include/lldb/Interpreter/CommandObject.h
lldb/include/lldb/Interpreter/Options.h
lldb/include/lldb/Symbol/Block.h
lldb/include/lldb/Symbol/CompileUnit.h
lldb/include/lldb/Symbol/Declaration.h
lldb/include/lldb/Symbol/Function.h
lldb/include/lldb/Symbol/LineEntry.h
lldb/include/lldb/Symbol/LineTable.h
lldb/include/lldb/Symbol/ObjectFile.h
lldb/include/lldb/Symbol/SymbolContext.h
lldb/include/lldb/Target/Platform.h
lldb/include/lldb/Target/Process.h
lldb/include/lldb/Target/StackFrame.h
lldb/include/lldb/Target/Target.h
lldb/include/lldb/Target/TargetList.h
lldb/include/lldb/Target/Thread.h
lldb/include/lldb/Utility/ConstString.h
lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionVariable.h
lldb/source/Plugins/ExpressionParser/Clang/ClangFunctionCaller.h
lldb/source/Plugins/ExpressionParser/Clang/ClangUserExpression.h
lldb/source/Plugins/ExpressionParser/Clang/IRDynamicChecks.h
lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h
lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.h
lldb/tools/lldb-vscode/LLDBUtils.h
Removed:
################################################################################
diff --git a/lldb/include/lldb/Breakpoint/Breakpoint.h b/lldb/include/lldb/Breakpoint/Breakpoint.h
index f561b6d900a1..94411bd57a67 100644
--- a/lldb/include/lldb/Breakpoint/Breakpoint.h
+++ b/lldb/include/lldb/Breakpoint/Breakpoint.h
@@ -193,7 +193,7 @@ class Breakpoint : public std::enable_shared_from_this<Breakpoint>,
/// Tell this breakpoint to scan a given module list and resolve any new
/// locations that match the breakpoint's specifications.
///
- /// \param[in] changed_modules
+ /// \param[in] module_list
/// The list of modules to look in for new locations.
///
/// \param[in] new_locations
@@ -205,7 +205,7 @@ class Breakpoint : public std::enable_shared_from_this<Breakpoint>,
/// which case we will remove any locations that are in modules that got
/// unloaded.
///
- /// \param[in] changedModules
+ /// \param[in] changed_modules
/// The list of modules to look in for new locations.
/// \param[in] load_event
/// If \b true then the modules were loaded, if \b false, unloaded.
@@ -372,10 +372,6 @@ class Breakpoint : public std::enable_shared_from_this<Breakpoint>,
/// If \b true the callback will be run on the private event thread
/// before the stop event gets reported. If false, the callback will get
/// handled on the public event thread after the stop has been posted.
- ///
- /// \return
- /// \b true if the process should stop when you hit the breakpoint.
- /// \b false if it should continue.
void SetCallback(BreakpointHitCallback callback, void *baton,
bool is_synchronous = false);
@@ -522,7 +518,7 @@ class Breakpoint : public std::enable_shared_from_this<Breakpoint>,
if (name_to_remove)
m_name_list.erase(name_to_remove);
}
-
+
public:
bool MatchesName(const char *name) {
return m_name_list.find(name) != m_name_list.end();
@@ -554,14 +550,14 @@ class Breakpoint : public std::enable_shared_from_this<Breakpoint>,
lldb::BreakpointPreconditionSP GetPrecondition() { return m_precondition_sp; }
// Produces the OR'ed values for all the names assigned to this breakpoint.
- const BreakpointName::Permissions &GetPermissions() const {
- return m_permissions;
+ const BreakpointName::Permissions &GetPermissions() const {
+ return m_permissions;
}
- BreakpointName::Permissions &GetPermissions() {
- return m_permissions;
+ BreakpointName::Permissions &GetPermissions() {
+ return m_permissions;
}
-
+
bool AllowList() const {
return GetPermissions().GetAllowList();
}
diff --git a/lldb/include/lldb/Breakpoint/BreakpointID.h b/lldb/include/lldb/Breakpoint/BreakpointID.h
index 095132988eb2..9daa5b6c5e8d 100644
--- a/lldb/include/lldb/Breakpoint/BreakpointID.h
+++ b/lldb/include/lldb/Breakpoint/BreakpointID.h
@@ -65,7 +65,7 @@ class BreakpointID {
/// If it is a mal-formed breakpoint name, error will be set to an appropriate
/// error string.
///
- /// \param[in] input
+ /// \param[in] str
/// A string containing JUST the breakpoint description.
/// \param[out] error
/// If the name is a well-formed breakpoint name, set to success,
diff --git a/lldb/include/lldb/Breakpoint/BreakpointList.h b/lldb/include/lldb/Breakpoint/BreakpointList.h
index fe10adbda8a6..110e8d41f36b 100644
--- a/lldb/include/lldb/Breakpoint/BreakpointList.h
+++ b/lldb/include/lldb/Breakpoint/BreakpointList.h
@@ -138,7 +138,7 @@ class BreakpointList {
/// Sets the passed in Locker to hold the Breakpoint List mutex.
///
- /// \param[in] locker
+ /// \param[in] lock
/// The locker object that is set.
void GetListMutex(std::unique_lock<std::recursive_mutex> &lock);
diff --git a/lldb/include/lldb/Breakpoint/BreakpointLocation.h b/lldb/include/lldb/Breakpoint/BreakpointLocation.h
index aadd52288485..86bb164162c1 100644
--- a/lldb/include/lldb/Breakpoint/BreakpointLocation.h
+++ b/lldb/include/lldb/Breakpoint/BreakpointLocation.h
@@ -93,7 +93,7 @@ class BreakpointLocation
/// Set the breakpoint to ignore the next \a count breakpoint hits.
///
- /// \param[in] count
+ /// \param[in] n
/// The number of breakpoint hits to ignore.
void SetIgnoreCount(uint32_t n);
@@ -224,9 +224,6 @@ class BreakpointLocation
/// \param[in] context
/// Described the breakpoint event.
///
- /// \param[in] bp_loc_id
- /// Which breakpoint location hit this breakpoint.
- ///
/// \return
/// \b true if the target should stop at this breakpoint and \b
/// false not.
diff --git a/lldb/include/lldb/Breakpoint/BreakpointLocationCollection.h b/lldb/include/lldb/Breakpoint/BreakpointLocationCollection.h
index 3da52eb7962a..be400636877e 100644
--- a/lldb/include/lldb/Breakpoint/BreakpointLocationCollection.h
+++ b/lldb/include/lldb/Breakpoint/BreakpointLocationCollection.h
@@ -22,17 +22,14 @@ class BreakpointLocationCollection {
BreakpointLocationCollection();
~BreakpointLocationCollection();
-
+
BreakpointLocationCollection &operator=(const BreakpointLocationCollection &rhs);
/// Add the breakpoint \a bp_loc_sp to the list.
///
- /// \param[in] bp_sp
+ /// \param[in] bp_loc_sp
/// Shared pointer to the breakpoint location that will get added
/// to the list.
- ///
- /// \result
- /// Returns breakpoint location id.
void Add(const lldb::BreakpointLocationSP &bp_loc_sp);
/// Removes the breakpoint location given by \b breakID from this
@@ -66,7 +63,7 @@ class BreakpointLocationCollection {
/// Returns a shared pointer to the breakpoint location with id \a
/// breakID, const version.
///
- /// \param[in] breakID
+ /// \param[in] break_id
/// The breakpoint location ID to seek for.
///
/// \param[in] break_loc_id
@@ -112,9 +109,6 @@ class BreakpointLocationCollection {
/// \param[in] context
/// This contains the information about this stop.
///
- /// \param[in] breakID
- /// This break ID that we hit.
- ///
/// \return
/// \b true if we should stop, \b false otherwise.
bool ShouldStop(StoppointCallbackContext *context);
diff --git a/lldb/include/lldb/Breakpoint/BreakpointLocationList.h b/lldb/include/lldb/Breakpoint/BreakpointLocationList.h
index b7e0e49cff83..89ad2f54c923 100644
--- a/lldb/include/lldb/Breakpoint/BreakpointLocationList.h
+++ b/lldb/include/lldb/Breakpoint/BreakpointLocationList.h
@@ -75,7 +75,7 @@ class BreakpointLocationList {
/// \param[in] module
/// The module to seek in.
///
- /// \param[in]
+ /// \param[in] bp_loc_list
/// A breakpoint collection that gets any breakpoint locations
/// that match \a module appended to.
///
@@ -166,14 +166,6 @@ class BreakpointLocationList {
/// list.
BreakpointLocationList(Breakpoint &owner);
- /// Add the breakpoint \a bp_loc_sp to the list.
- ///
- /// \param[in] bp_sp
- /// Shared pointer to the breakpoint location that will get
- /// added to the list.
- ///
- /// \result
- /// Returns breakpoint location id.
lldb::BreakpointLocationSP Create(const Address &addr,
bool resolve_indirect_symbols);
@@ -189,7 +181,7 @@ class BreakpointLocationList {
lldb::BreakpointLocationSP from_location_sp);
bool RemoveLocation(const lldb::BreakpointLocationSP &bp_loc_sp);
-
+
void RemoveLocationByIndex(size_t idx);
void RemoveInvalidLocations(const ArchSpec &arch);
diff --git a/lldb/include/lldb/Breakpoint/BreakpointResolver.h b/lldb/include/lldb/Breakpoint/BreakpointResolver.h
index 11e183b33482..c1dbf9ac0aee 100644
--- a/lldb/include/lldb/Breakpoint/BreakpointResolver.h
+++ b/lldb/include/lldb/Breakpoint/BreakpointResolver.h
@@ -44,9 +44,6 @@ class BreakpointResolver : public Searcher {
/// The breakpoint that owns this resolver.
/// \param[in] resolverType
/// The concrete breakpoint resolver type for this breakpoint.
- ///
- /// \result
- /// Returns breakpoint location id.
BreakpointResolver(Breakpoint *bkpt, unsigned char resolverType,
lldb::addr_t offset = 0);
@@ -186,7 +183,7 @@ class BreakpointResolver : public Searcher {
};
static const char
*g_option_names[static_cast<uint32_t>(OptionNames::LastOptionName)];
-
+
virtual void NotifyBreakpointSet() {};
public:
diff --git a/lldb/include/lldb/Breakpoint/BreakpointSite.h b/lldb/include/lldb/Breakpoint/BreakpointSite.h
index 51ed84f7bf2d..5c9f79a9ab1c 100644
--- a/lldb/include/lldb/Breakpoint/BreakpointSite.h
+++ b/lldb/include/lldb/Breakpoint/BreakpointSite.h
@@ -99,15 +99,12 @@ class BreakpointSite : public std::enable_shared_from_this<BreakpointSite>,
bool ShouldStop(StoppointCallbackContext *context) override;
/// Standard Dump method
- ///
- /// \param[in] context
- /// The stream to dump this output.
void Dump(Stream *s) const override;
/// The "Owners" are the breakpoint locations that share this breakpoint
/// site. The method adds the \a owner to this breakpoint site's owner list.
///
- /// \param[in] context
+ /// \param[in] owner
/// \a owner is the Breakpoint Location to add.
void AddOwner(const lldb::BreakpointLocationSP &owner);
@@ -123,8 +120,9 @@ class BreakpointSite : public std::enable_shared_from_this<BreakpointSite>,
/// GetNumberOfOwners() - 1 so you can use this method to iterate over the
/// owners
///
- /// \param[in] index
+ /// \param[in] idx
/// The index in the list of owners for which you wish the owner location.
+ ///
/// \return
/// A shared pointer to the breakpoint location at that index.
lldb::BreakpointLocationSP GetOwnerAtIndex(size_t idx);
@@ -201,9 +199,6 @@ class BreakpointSite : public std::enable_shared_from_this<BreakpointSite>,
/// The method removes the owner at \a break_loc_id from this breakpoint
/// list.
- ///
- /// \param[in] context
- /// \a break_loc_id is the Breakpoint Location to remove.
size_t RemoveOwner(lldb::break_id_t break_id, lldb::break_id_t break_loc_id);
BreakpointSite::Type m_type; ///< The type of this breakpoint site.
diff --git a/lldb/include/lldb/Breakpoint/Watchpoint.h b/lldb/include/lldb/Breakpoint/Watchpoint.h
index e71f89b3e384..2cc74bb4c632 100644
--- a/lldb/include/lldb/Breakpoint/Watchpoint.h
+++ b/lldb/include/lldb/Breakpoint/Watchpoint.h
@@ -69,7 +69,6 @@ class Watchpoint : public std::enable_shared_from_this<Watchpoint>,
// This doesn't really enable/disable the watchpoint. It is currently just
// for use in the Process plugin's {Enable,Disable}Watchpoint, which should
// be used instead.
-
void SetEnabled(bool enabled, bool notify = true);
bool IsHardware() const override;
@@ -113,10 +112,6 @@ class Watchpoint : public std::enable_shared_from_this<Watchpoint>,
/// If \b true the callback will be run on the private event thread
/// before the stop event gets reported. If false, the callback will get
/// handled on the public event thread after the stop has been posted.
- ///
- /// \return
- /// \b true if the process should stop when you hit the watchpoint.
- /// \b false if it should continue.
void SetCallback(WatchpointHitCallback callback, void *callback_baton,
bool is_synchronous = false);
diff --git a/lldb/include/lldb/Breakpoint/WatchpointList.h b/lldb/include/lldb/Breakpoint/WatchpointList.h
index 98c64832d46d..bb73d4ab75da 100644
--- a/lldb/include/lldb/Breakpoint/WatchpointList.h
+++ b/lldb/include/lldb/Breakpoint/WatchpointList.h
@@ -180,7 +180,7 @@ class WatchpointList {
/// Sets the passed in Locker to hold the Watchpoint List mutex.
///
- /// \param[in] locker
+ /// \param[in] lock
/// The locker object that is set.
void GetListMutex(std::unique_lock<std::recursive_mutex> &lock);
diff --git a/lldb/include/lldb/Core/Address.h b/lldb/include/lldb/Core/Address.h
index 07bb450d6092..386c3f1a0f85 100644
--- a/lldb/include/lldb/Core/Address.h
+++ b/lldb/include/lldb/Core/Address.h
@@ -61,45 +61,55 @@ class Address {
/// Dump styles allow the Address::Dump(Stream *,DumpStyle) const function
/// to display Address contents in a variety of ways.
enum DumpStyle {
- DumpStyleInvalid, ///< Invalid dump style
- DumpStyleSectionNameOffset, ///< Display as the section name + offset.
- ///< \code
+ /// Invalid dump style.
+ DumpStyleInvalid,
+ /// Display as the section name + offset.
+ /// \code
/// // address for printf in libSystem.B.dylib as a section name + offset
- /// libSystem.B.dylib.__TEXT.__text + 0x0005cfdf \endcode
- DumpStyleSectionPointerOffset, ///< Display as the section pointer + offset
- ///(debug output).
- ///< \code
+ /// libSystem.B.dylib.__TEXT.__text + 0x0005cfdf
+ /// \endcode
+ DumpStyleSectionNameOffset,
+ /// Display as the section pointer + offset (debug output).
+ /// \code
/// // address for printf in libSystem.B.dylib as a section pointer +
- /// offset (lldb::Section *)0x35cc50 + 0x000000000005cfdf \endcode
- DumpStyleFileAddress, ///< Display as the file address (if any).
- ///< \code
+ /// offset (lldb::Section *)0x35cc50 + 0x000000000005cfdf
+ /// \endcode
+ DumpStyleSectionPointerOffset,
+ /// Display as the file address (if any).
+ /// \code
/// // address for printf in libSystem.B.dylib as a file address
- /// 0x000000000005dcff \endcode
- DumpStyleModuleWithFileAddress, ///< Display as the file address with the
- /// module name prepended (if any).
- ///< \code
+ /// 0x000000000005dcff
+ /// \endcode
+ ///
+ DumpStyleFileAddress,
+ /// Display as the file address with the module name prepended (if any).
+ /// \code
/// // address for printf in libSystem.B.dylib as a file address
- /// libSystem.B.dylib[0x000000000005dcff] \endcode
- DumpStyleLoadAddress, ///< Display as the load address (if resolved).
- ///< \code
+ /// libSystem.B.dylib[0x000000000005dcff]
+ /// \endcode
+ DumpStyleModuleWithFileAddress,
+ /// Display as the load address (if resolved).
+ /// \code
/// // address for printf in libSystem.B.dylib as a load address
- /// 0x00007fff8306bcff \endcode
- DumpStyleResolvedDescription, ///< Display the details about what an address
- /// resolves to. This can
- ///< be anything from a symbol context summary (module, function/symbol,
- ///< and file and line), to information about what the pointer points to
- ///< if the address is in a section (section of pointers, c strings, etc).
+ /// 0x00007fff8306bcff
+ /// \endcode
+ DumpStyleLoadAddress,
+ /// Display the details about what an address resolves to. This can be
+ /// anything from a symbol context summary (module, function/symbol, and
+ /// file and line), to information about what the pointer points to if the
+ /// address is in a section (section of pointers, c strings, etc).
+ DumpStyleResolvedDescription,
DumpStyleResolvedDescriptionNoModule,
DumpStyleResolvedDescriptionNoFunctionArguments,
- DumpStyleNoFunctionName, ///< Elide the function name; display an offset
- /// into the current function.
- ///< Used primarily in disassembly symbolication
- DumpStyleDetailedSymbolContext, ///< Detailed symbol context information for
- /// an address for all symbol
- ///< context members.
- DumpStyleResolvedPointerDescription ///< Dereference a pointer at the
- /// current address and then lookup the
- ///< dereferenced address using DumpStyleResolvedDescription
+ /// Elide the function name; display an offset into the current function.
+ /// Used primarily in disassembly symbolication
+ DumpStyleNoFunctionName,
+ /// Detailed symbol context information for an address for all symbol
+ /// context members.
+ DumpStyleDetailedSymbolContext,
+ /// Dereference a pointer at the current address and then lookup the
+ /// dereferenced address using DumpStyleResolvedDescription
+ DumpStyleResolvedPointerDescription
};
/// Default constructor.
@@ -179,9 +189,9 @@ class Address {
/// The Right Hand Side const Address object reference.
///
/// \return
- /// \li -1 if lhs < rhs
- /// \li 0 if lhs == rhs
- /// \li 1 if lhs > rhs
+ /// -1 if lhs < rhs
+ /// 0 if lhs == rhs
+ /// 1 if lhs > rhs
static int CompareFileAddress(const Address &lhs, const Address &rhs);
static int CompareLoadAddress(const Address &lhs, const Address &rhs,
diff --git a/lldb/include/lldb/Core/AddressRange.h b/lldb/include/lldb/Core/AddressRange.h
index 4a019bfcfc3f..ac748713a182 100644
--- a/lldb/include/lldb/Core/AddressRange.h
+++ b/lldb/include/lldb/Core/AddressRange.h
@@ -123,7 +123,7 @@ class AddressRange {
/// Check if the resolved file address \a file_addr is contained within this
/// object's file address range.
///
- /// \param[in] so_addr
+ /// \param[in] file_addr
/// A section offset address object reference.
///
/// \return
@@ -147,9 +147,6 @@ class AddressRange {
/// Check if the resolved load address \a load_addr is contained within this
/// object's load address range.
///
- /// \param[in] so_addr
- /// A section offset address object reference.
- ///
/// \return
/// Returns \b true if both \a this has a resolvable load
/// address value and \a so_addr is contained in the address
diff --git a/lldb/include/lldb/Core/Highlighter.h b/lldb/include/lldb/Core/Highlighter.h
index 88d3bb3a3cd1..8a268ec1d6b1 100644
--- a/lldb/include/lldb/Core/Highlighter.h
+++ b/lldb/include/lldb/Core/Highlighter.h
@@ -43,8 +43,6 @@ struct HighlightStyle {
void Apply(Stream &s, llvm::StringRef value) const;
/// Sets the prefix and suffix strings.
- /// \param prefix
- /// \param suffix
void Set(llvm::StringRef prefix, llvm::StringRef suffix);
};
@@ -100,6 +98,7 @@ class Highlighter {
/// Highlights the given line
/// \param options
+ /// The highlight options.
/// \param line
/// The user supplied line that needs to be highlighted.
/// \param cursor_pos
diff --git a/lldb/include/lldb/Core/Mangled.h b/lldb/include/lldb/Core/Mangled.h
index 8d6fa77745e5..6af68c3f5857 100644
--- a/lldb/include/lldb/Core/Mangled.h
+++ b/lldb/include/lldb/Core/Mangled.h
@@ -108,9 +108,9 @@ class Mangled {
/// A const reference to the Right Hand Side object to compare.
///
/// \return
- /// \li -1 if \a lhs is less than \a rhs
- /// \li 0 if \a lhs is equal to \a rhs
- /// \li 1 if \a lhs is greater than \a rhs
+ /// -1 if \a lhs is less than \a rhs
+ /// 0 if \a lhs is equal to \a rhs
+ /// 1 if \a lhs is greater than \a rhs
static int Compare(const Mangled &lhs, const Mangled &rhs);
/// Dump a description of this object to a Stream \a s.
diff --git a/lldb/include/lldb/Core/Module.h b/lldb/include/lldb/Core/Module.h
index 0f1d276337c1..bb6c9bdad760 100644
--- a/lldb/include/lldb/Core/Module.h
+++ b/lldb/include/lldb/Core/Module.h
@@ -291,9 +291,6 @@ class Module : public std::enable_shared_from_this<Module>,
/// \param[in] name
/// The name of the compile unit we are looking for.
///
- /// \param[in] namespace_decl
- /// If valid, a namespace to search in.
- ///
/// \param[in] name_type_mask
/// A bit mask of bits that indicate what kind of names should
/// be used when doing the lookup. Bits include fully qualified
@@ -317,10 +314,6 @@ class Module : public std::enable_shared_from_this<Module>,
/// \param[in] regex
/// A regular expression to use when matching the name.
///
- /// \param[in] append
- /// If \b true, any matches will be appended to \a sc_list, else
- /// matches replace the contents of \a sc_list.
- ///
/// \param[out] sc_list
/// A symbol context list that gets filled in with all of the
/// matches.
@@ -416,7 +409,7 @@ class Module : public std::enable_shared_from_this<Module>,
/// omitted to make finding types that a user may type
/// easier.
///
- /// \param[out] type_list
+ /// \param[out] types
/// A type list gets populated with any matches.
///
void
@@ -447,12 +440,8 @@ class Module : public std::enable_shared_from_this<Module>,
/// The name of a type within a namespace that should not include
/// any qualifying namespaces (just a type basename).
///
- /// \param[in] namespace_decl
- /// The namespace declaration that this type must exist in.
- ///
/// \param[out] type_list
/// A type list gets populated with any matches.
- ///
void FindTypesInNamespace(ConstString type_name,
const CompilerDeclContext *parent_decl_ctx,
size_t max_matches, TypeList &type_list);
diff --git a/lldb/include/lldb/Core/ModuleChild.h b/lldb/include/lldb/Core/ModuleChild.h
index 8a81c1a6cf8a..0d59e4fb12ca 100644
--- a/lldb/include/lldb/Core/ModuleChild.h
+++ b/lldb/include/lldb/Core/ModuleChild.h
@@ -20,7 +20,7 @@ class ModuleChild {
public:
/// Construct with owning module.
///
- /// \param[in] module
+ /// \param[in] module_sp
/// The module that owns the object that inherits from this
/// class.
ModuleChild(const lldb::ModuleSP &module_sp);
@@ -46,15 +46,14 @@ class ModuleChild {
/// Set accessor for the module pointer.
///
- /// \param[in] module
+ /// \param[in] module_sp
/// A new module that owns the object that inherits from this
- /// class.
+ /// class.
void SetModule(const lldb::ModuleSP &module_sp);
protected:
- // Member variables
- lldb::ModuleWP m_module_wp; ///< The Module that owns the object that inherits
- ///< from this class.
+ /// The Module that owns the object that inherits from this class.
+ lldb::ModuleWP m_module_wp;
};
} // namespace lldb_private
diff --git a/lldb/include/lldb/Core/ModuleList.h b/lldb/include/lldb/Core/ModuleList.h
index e21655551b61..a6e80ed75c76 100644
--- a/lldb/include/lldb/Core/ModuleList.h
+++ b/lldb/include/lldb/Core/ModuleList.h
@@ -53,7 +53,7 @@ class ModuleListProperties : public Properties {
bool SetClangModulesCachePath(llvm::StringRef path);
bool GetEnableExternalLookup() const;
bool SetEnableExternalLookup(bool new_value);
-};
+};
/// \class ModuleList ModuleList.h "lldb/Core/ModuleList.h"
/// A collection class for Module objects.
@@ -116,10 +116,10 @@ class ModuleList {
/// If true, and a notifier function is set, the notifier function
/// will be called. Defaults to true.
///
- /// When this ModuleList is the Target's ModuleList, the notifier
- /// function is Target::ModulesDidLoad -- the call to
- /// ModulesDidLoad may be deferred when adding multiple Modules
- /// to the Target, but it must be called at the end,
+ /// When this ModuleList is the Target's ModuleList, the notifier
+ /// function is Target::ModulesDidLoad -- the call to
+ /// ModulesDidLoad may be deferred when adding multiple Modules
+ /// to the Target, but it must be called at the end,
/// before resuming execution.
void Append(const lldb::ModuleSP &module_sp, bool notify = true);
@@ -135,16 +135,14 @@ class ModuleList {
/// Append a module to the module list, if it is not already there.
///
- /// \param[in] module_sp
- ///
/// \param[in] notify
/// If true, and a notifier function is set, the notifier function
/// will be called. Defaults to true.
///
- /// When this ModuleList is the Target's ModuleList, the notifier
- /// function is Target::ModulesDidLoad -- the call to
- /// ModulesDidLoad may be deferred when adding multiple Modules
- /// to the Target, but it must be called at the end,
+ /// When this ModuleList is the Target's ModuleList, the notifier
+ /// function is Target::ModulesDidLoad -- the call to
+ /// ModulesDidLoad may be deferred when adding multiple Modules
+ /// to the Target, but it must be called at the end,
/// before resuming execution.
bool AppendIfNeeded(const lldb::ModuleSP &module_sp, bool notify = true);
@@ -297,7 +295,7 @@ class ModuleList {
/// Finds the first module whose file specification matches \a file_spec.
///
- /// \param[in] file_spec_ptr
+ /// \param[in] module_spec
/// A file specification object to match against the Module's
/// file specifications. If \a file_spec does not have
/// directory information, matches will occur by matching only
@@ -305,18 +303,6 @@ class ModuleList {
/// NULL, then file specifications won't be compared when
/// searching for matching modules.
///
- /// \param[in] arch_ptr
- /// The architecture to search for if non-NULL. If this value
- /// is NULL no architecture matching will be performed.
- ///
- /// \param[in] uuid_ptr
- /// The uuid to search for if non-NULL. If this value is NULL
- /// no uuid matching will be performed.
- ///
- /// \param[in] object_name
- /// An optional object name that must match as well. This value
- /// can be NULL.
- ///
/// \param[out] matching_module_list
/// A module list that gets filled in with any modules that
/// match the search criteria.
@@ -351,24 +337,11 @@ class ModuleList {
/// \param[in] name
/// The name of the type we are looking for.
///
- /// \param[in] append
- /// If \b true, any matches will be appended to \a
- /// variable_list, else matches replace the contents of
- /// \a variable_list.
- ///
/// \param[in] max_matches
/// Allow the number of matches to be limited to \a
/// max_matches. Specify UINT32_MAX to get all possible matches.
///
- /// \param[in] encoding
- /// Limit the search to specific types, or get all types if
- /// set to Type::invalid.
- ///
- /// \param[in] udt_name
- /// If the encoding is a user defined type, specify the name
- /// of the user defined type ("struct", "union", "class", etc).
- ///
- /// \param[out] type_list
+ /// \param[out] types
/// A type list gets populated with any matches.
///
void FindTypes(Module *search_first, ConstString name,
@@ -414,10 +387,10 @@ class ModuleList {
/// If true, and a notifier function is set, the notifier function
/// will be called. Defaults to true.
///
- /// When this ModuleList is the Target's ModuleList, the notifier
- /// function is Target::ModulesDidUnload -- the call to
- /// ModulesDidUnload may be deferred when removing multiple Modules
- /// from the Target, but it must be called at the end,
+ /// When this ModuleList is the Target's ModuleList, the notifier
+ /// function is Target::ModulesDidUnload -- the call to
+ /// ModulesDidUnload may be deferred when removing multiple Modules
+ /// from the Target, but it must be called at the end,
/// before resuming execution.
bool Remove(const lldb::ModuleSP &module_sp, bool notify = true);
@@ -477,7 +450,7 @@ class ModuleList {
static size_t RemoveOrphanSharedModules(bool mandatory);
static bool RemoveSharedModuleIfOrphaned(const Module *module_ptr);
-
+
void ForEach(std::function<bool(const lldb::ModuleSP &module_sp)> const
&callback) const;
diff --git a/lldb/include/lldb/Core/SearchFilter.h b/lldb/include/lldb/Core/SearchFilter.h
index 97880f693887..74c4f3162a1c 100644
--- a/lldb/include/lldb/Core/SearchFilter.h
+++ b/lldb/include/lldb/Core/SearchFilter.h
@@ -84,7 +84,7 @@ class SearchFilter {
public:
/// The basic constructor takes a Target, which gives the space to search.
///
- /// \param[in] target
+ /// \param[in] target_sp
/// The Target that provides the module list to search.
SearchFilter(const lldb::TargetSP &target_sp);
@@ -102,7 +102,7 @@ class SearchFilter {
/// Call this method with a Module to see if that module passes the filter.
///
- /// \param[in] module
+ /// \param[in] module_sp
/// The Module to check against the filter.
///
/// \return
@@ -306,7 +306,7 @@ class SearchFilterByModule : public SearchFilter {
/// The basic constructor takes a Target, which gives the space to search,
/// and the module to restrict the search to.
///
- /// \param[in] target
+ /// \param[in] targetSP
/// The Target that provides the module list to search.
///
/// \param[in] module
@@ -352,10 +352,10 @@ class SearchFilterByModuleList : public SearchFilter {
/// The basic constructor takes a Target, which gives the space to search,
/// and the module list to restrict the search to.
///
- /// \param[in] target
+ /// \param[in] targetSP
/// The Target that provides the module list to search.
///
- /// \param[in] module
+ /// \param[in] module_list
/// The Module that limits the search.
SearchFilterByModuleList(const lldb::TargetSP &targetSP,
const FileSpecList &module_list);
@@ -404,12 +404,6 @@ class SearchFilterByModuleListAndCU : public SearchFilterByModuleList {
public:
/// The basic constructor takes a Target, which gives the space to search,
/// and the module list to restrict the search to.
- ///
- /// \param[in] target
- /// The Target that provides the module list to search.
- ///
- /// \param[in] module
- /// The Module that limits the search.
SearchFilterByModuleListAndCU(const lldb::TargetSP &targetSP,
const FileSpecList &module_list,
const FileSpecList &cu_list);
diff --git a/lldb/include/lldb/Expression/DWARFExpression.h b/lldb/include/lldb/Expression/DWARFExpression.h
index 44015b4e418f..d82882522af6 100644
--- a/lldb/include/lldb/Expression/DWARFExpression.h
+++ b/lldb/include/lldb/Expression/DWARFExpression.h
@@ -184,19 +184,6 @@ class DWARFExpression {
/// This is a static method so the opcodes need to be provided
/// explicitly.
///
- /// \param[in] expr_locals
- /// If the location expression was produced by the expression parser,
- /// the list of local variables referenced by the DWARF expression.
- /// This list should already have been populated during parsing;
- /// the DWARF expression refers to variables by index. Can be NULL if
- /// the location expression uses no locals.
- ///
- /// \param[in] decl_map
- /// If the location expression was produced by the expression parser,
- /// the list of external variables referenced by the location
- /// expression. Can be NULL if the location expression uses no
- /// external variables.
- ///
/// \param[in] reg_ctx
/// An optional parameter which provides a RegisterContext for use
/// when evaluating the expression (i.e. for fetching register values).
@@ -251,7 +238,7 @@ class DWARFExpression {
private:
/// Pretty-prints the location expression to a stream
///
- /// \param[in] stream
+ /// \param[in] s
/// The stream to use for pretty-printing.
///
/// \param[in] offset
diff --git a/lldb/include/lldb/Expression/FunctionCaller.h b/lldb/include/lldb/Expression/FunctionCaller.h
index 6f60750febd1..1303655f449f 100644
--- a/lldb/include/lldb/Expression/FunctionCaller.h
+++ b/lldb/include/lldb/Expression/FunctionCaller.h
@@ -67,10 +67,7 @@ class FunctionCaller : public Expression {
/// An execution context scope that gets us at least a target and
/// process.
///
- /// \param[in] ast_context
- /// The AST context to evaluate argument types in.
- ///
- /// \param[in] return_qualtype
+ /// \param[in] return_type
/// An opaque Clang QualType for the function result. Should be
/// defined in ast_context.
///
@@ -224,21 +221,12 @@ class FunctionCaller : public Expression {
/// The execution context to insert the function and its arguments
/// into.
///
- /// \param[in] func_addr
- /// The address of the function in the target process.
- ///
/// \param[in] args_addr
/// The address of the argument struct.
///
/// \param[in] diagnostic_manager
/// The diagnostic manager to report errors to.
///
- /// \param[in] stop_others
- /// True if other threads should pause during execution.
- ///
- /// \param[in] unwind_on_error
- /// True if the thread plan may simply be discarded if an error occurs.
- ///
/// \return
/// A ThreadPlan shared pointer for executing the function.
lldb::ThreadPlanSP
diff --git a/lldb/include/lldb/Expression/IRExecutionUnit.h b/lldb/include/lldb/Expression/IRExecutionUnit.h
index f3cb7e36b2e3..05f2f8471ef8 100644
--- a/lldb/include/lldb/Expression/IRExecutionUnit.h
+++ b/lldb/include/lldb/Expression/IRExecutionUnit.h
@@ -173,6 +173,8 @@ class IRExecutionUnit : public std::enable_shared_from_this<IRExecutionUnit>,
/// The address in the target process.
lldb::addr_t GetRemoteAddressForLocal(lldb::addr_t local_address);
+ typedef std::pair<lldb::addr_t, uintptr_t> AddrRange;
+
/// Look up the object in m_address_map that contains a given address, find
/// where it was copied to, and return its address range in the target
/// process
@@ -182,12 +184,11 @@ class IRExecutionUnit : public std::enable_shared_from_this<IRExecutionUnit>,
///
/// \return
/// The range of the containing object in the target process.
- typedef std::pair<lldb::addr_t, uintptr_t> AddrRange;
AddrRange GetRemoteRangeForLocal(lldb::addr_t local_address);
/// Commit all allocations to the process and record where they were stored.
///
- /// \param[in] process
+ /// \param[in] process_sp
/// The process to allocate memory in.
///
/// \return
@@ -204,7 +205,7 @@ class IRExecutionUnit : public std::enable_shared_from_this<IRExecutionUnit>,
/// Write the contents of all allocations to the process.
///
- /// \param[in] local_address
+ /// \param[in] process_sp
/// The process containing the allocations.
///
/// \return
@@ -304,12 +305,12 @@ class IRExecutionUnit : public std::enable_shared_from_this<IRExecutionUnit>,
void deregisterEHFrames() override {}
uint64_t getSymbolAddress(const std::string &Name) override;
-
+
// Find the address of the symbol Name. If Name is a missing weak symbol
// then missing_weak will be true.
- uint64_t GetSymbolAddressAndPresence(const std::string &Name,
+ uint64_t GetSymbolAddressAndPresence(const std::string &Name,
bool &missing_weak);
-
+
llvm::JITSymbol findSymbol(const std::string &Name) override;
void *getPointerToNamedFunction(const std::string &Name,
@@ -328,18 +329,16 @@ class IRExecutionUnit : public std::enable_shared_from_this<IRExecutionUnit>,
static const unsigned eSectionIDInvalid = (unsigned)-1;
- /// \class AllocationRecord IRExecutionUnit.h
- /// "lldb/Expression/IRExecutionUnit.h" Encapsulates a single allocation
- /// request made by the JIT.
- ///
- /// Allocations made by the JIT are first queued up and then applied in bulk
- /// to the underlying process.
enum class AllocationKind { Stub, Code, Data, Global, Bytes };
static lldb::SectionType
GetSectionTypeFromSectionName(const llvm::StringRef &name,
AllocationKind alloc_kind);
+ /// Encapsulates a single allocation request made by the JIT.
+ ///
+ /// Allocations made by the JIT are first queued up and then applied in bulk
+ /// to the underlying process.
struct AllocationRecord {
std::string m_name;
lldb::addr_t m_process_address;
diff --git a/lldb/include/lldb/Expression/REPL.h b/lldb/include/lldb/Expression/REPL.h
index d34a792f58f1..035ad63271e4 100644
--- a/lldb/include/lldb/Expression/REPL.h
+++ b/lldb/include/lldb/Expression/REPL.h
@@ -32,7 +32,7 @@ class REPL : public IOHandlerDelegate {
/// Get a REPL with an existing target (or, failing that, a debugger to use),
/// and (optional) extra arguments for the compiler.
///
- /// \param[out] error
+ /// \param[out] Status
/// If this language is supported but the REPL couldn't be created, this
/// error is populated with the reason.
///
diff --git a/lldb/include/lldb/Expression/UserExpression.h b/lldb/include/lldb/Expression/UserExpression.h
index 02d2991fff6b..c669cac2974b 100644
--- a/lldb/include/lldb/Expression/UserExpression.h
+++ b/lldb/include/lldb/Expression/UserExpression.h
@@ -47,10 +47,6 @@ class UserExpression : public Expression {
/// \param[in] expr
/// The expression to parse.
///
- /// \param[in] expr_prefix
- /// If non-nullptr, a C string containing translation-unit level
- /// definitions to be included when the expression is parsed.
- ///
/// \param[in] language
/// If not eLanguageTypeUnknown, a language to use when parsing
/// the expression. Currently restricted to those languages
@@ -166,8 +162,14 @@ class UserExpression : public Expression {
/// A pointer to direct at the persistent variable in which the
/// expression's result is stored.
///
- /// \param[in] function_stack_pointer
- /// A pointer to the base of the function's stack frame. This
+ /// \param[in] function_stack_bottom
+ /// A pointer to the bottom of the function's stack frame. This
+ /// is used to determine whether the expression result resides in
+ /// memory that will still be valid, or whether it needs to be
+ /// treated as homeless for the purpose of future expressions.
+ ///
+ /// \param[in] function_stack_top
+ /// A pointer to the top of the function's stack frame. This
/// is used to determine whether the expression result resides in
/// memory that will still be valid, or whether it needs to be
/// treated as homeless for the purpose of future expressions.
diff --git a/lldb/include/lldb/Host/File.h b/lldb/include/lldb/Host/File.h
index 0102beb141ee..9beb20556dcd 100644
--- a/lldb/include/lldb/Host/File.h
+++ b/lldb/include/lldb/Host/File.h
@@ -76,9 +76,7 @@ class File : public IOObject {
/// that takes an "off_t &offset" to ensure correct operation in multi-
/// threaded environments.
///
- /// \param[out] buf
- ///
- /// \param[in,out] num_bytes.
+ /// \param[in,out] num_bytes
/// Pass in the size of buf. Read will pass out the number
/// of bytes read. Zero bytes read with no error indicates
/// EOF.
@@ -93,8 +91,6 @@ class File : public IOObject {
/// that takes an "off_t &offset" to ensure correct operation in multi-
/// threaded environments.
///
- /// \param[in] buf
- ///
/// \param[in,out] num_bytes
/// Pass in the size of buf. Write will pass out the number
/// of bytes written. Write will attempt write the full number
diff --git a/lldb/include/lldb/Host/HostInfoBase.h b/lldb/include/lldb/Host/HostInfoBase.h
index 6f6688941ac7..5f0a4ab01f69 100644
--- a/lldb/include/lldb/Host/HostInfoBase.h
+++ b/lldb/include/lldb/Host/HostInfoBase.h
@@ -39,11 +39,6 @@ class HostInfoBase {
/// A const string object containing the host target triple.
static llvm::StringRef GetTargetTriple();
- /// Gets the host architecture.
- ///
- /// \return
- /// A const architecture object that represents the host
- /// architecture.
enum ArchitectureKind {
eArchKindDefault, // The overall default architecture that applications will
// run on this host
diff --git a/lldb/include/lldb/Host/HostProcess.h b/lldb/include/lldb/Host/HostProcess.h
index d48ff1fc90ee..fcea52a284d9 100644
--- a/lldb/include/lldb/Host/HostProcess.h
+++ b/lldb/include/lldb/Host/HostProcess.h
@@ -12,7 +12,6 @@
#include "lldb/Host/Host.h"
#include "lldb/lldb-types.h"
-/// \class HostInfo HostInfo.h "lldb/Host/HostProcess.h"
/// A class that represents a running process on the host machine.
///
/// HostProcess allows querying and manipulation of processes running on the
diff --git a/lldb/include/lldb/Host/PseudoTerminal.h b/lldb/include/lldb/Host/PseudoTerminal.h
index 8b27890ddeeb..18679b6fcdd9 100644
--- a/lldb/include/lldb/Host/PseudoTerminal.h
+++ b/lldb/include/lldb/Host/PseudoTerminal.h
@@ -61,14 +61,14 @@ class PseudoTerminal {
/// PseudoTerminal::ReleaseMasterFileDescriptor() @li
/// PseudoTerminal::ReleaseSaveFileDescriptor()
///
- /// \param[out] error
+ /// \param[out] error_str
/// An pointer to an error that can describe any errors that
/// occur. This can be NULL if no error status is desired.
///
/// \return
- /// \li \b Parent process: a child process ID that is greater
+ /// \b Parent process: a child process ID that is greater
/// than zero, or -1 if the fork fails.
- /// \li \b Child process: zero.
+ /// \b Child process: zero.
lldb::pid_t Fork(char *error_str, size_t error_len);
/// The master file descriptor accessor.
@@ -104,7 +104,7 @@ class PseudoTerminal {
/// A master pseudo terminal should already be valid prior to
/// calling this function.
///
- /// \param[out] error
+ /// \param[out] error_str
/// An pointer to an error that can describe any errors that
/// occur. This can be NULL if no error status is desired.
///
@@ -136,14 +136,14 @@ class PseudoTerminal {
/// Flags to use when calling \c posix_openpt(\a oflag).
/// A value of "O_RDWR|O_NOCTTY" is suggested.
///
- /// \param[out] error
+ /// \param[out] error_str
/// An pointer to an error that can describe any errors that
/// occur. This can be NULL if no error status is desired.
///
/// \return
- /// \li \b true when the master files descriptor is
+ /// \b true when the master files descriptor is
/// successfully opened.
- /// \li \b false if anything goes wrong.
+ /// \b false if anything goes wrong.
///
/// \see PseudoTerminal::GetMasterFileDescriptor() @see
/// PseudoTerminal::ReleaseMasterFileDescriptor()
@@ -165,14 +165,14 @@ class PseudoTerminal {
/// \param[in] oflag
/// Flags to use when calling \c open(\a oflag).
///
- /// \param[out] error
+ /// \param[out] error_str
/// An pointer to an error that can describe any errors that
/// occur. This can be NULL if no error status is desired.
///
/// \return
- /// \li \b true when the master files descriptor is
+ /// \b true when the master files descriptor is
/// successfully opened.
- /// \li \b false if anything goes wrong.
+ /// \b false if anything goes wrong.
///
/// \see PseudoTerminal::OpenFirstAvailableMaster() @see
/// PseudoTerminal::GetSlaveFileDescriptor() @see
diff --git a/lldb/include/lldb/Interpreter/CommandInterpreter.h b/lldb/include/lldb/Interpreter/CommandInterpreter.h
index 080d635716f1..13bde7284ee5 100644
--- a/lldb/include/lldb/Interpreter/CommandInterpreter.h
+++ b/lldb/include/lldb/Interpreter/CommandInterpreter.h
@@ -51,7 +51,7 @@ class CommandInterpreterRunOptions {
/// \param[in] echo_comments
/// If \b true, echo command even if it is a pure comment line. If
/// \b false, print no ouput in this case. This setting has an effect only
- /// if \param echo_commands is \b true.
+ /// if echo_commands is \b true.
/// \param[in] print_results
/// If \b true and the command succeeds, print the results of the command
/// after executing it. If \b false, execute silently.
diff --git a/lldb/include/lldb/Interpreter/CommandObject.h b/lldb/include/lldb/Interpreter/CommandObject.h
index 2dad84f036c0..1c6eb286348d 100644
--- a/lldb/include/lldb/Interpreter/CommandObject.h
+++ b/lldb/include/lldb/Interpreter/CommandObject.h
@@ -226,7 +226,7 @@ class CommandObject {
/// option. Don't override this method, override HandleArgumentCompletion
/// instead unless you have special reasons.
///
- /// \param[in/out] request
+ /// \param[in,out] request
/// The completion request that needs to be answered.
virtual void HandleCompletion(CompletionRequest &request);
@@ -235,7 +235,7 @@ class CommandObject {
/// We've constructed the map of options and their arguments as well if that
/// is helpful for the completion.
///
- /// \param[in/out] request
+ /// \param[in,out] request
/// The completion request that needs to be answered.
virtual void
HandleArgumentCompletion(CompletionRequest &request,
diff --git a/lldb/include/lldb/Interpreter/Options.h b/lldb/include/lldb/Interpreter/Options.h
index b6c824d5a199..d07c2560ef2d 100644
--- a/lldb/include/lldb/Interpreter/Options.h
+++ b/lldb/include/lldb/Interpreter/Options.h
@@ -163,7 +163,7 @@ class Options {
/// Handles the generic bits of figuring out whether we are in an option,
/// and if so completing it.
///
- /// \param[in/out] request
+ /// \param[in,out] request
/// The completion request that we need to act upon.
///
/// \param[in] interpreter
@@ -182,7 +182,7 @@ class Options {
/// Handles the generic bits of figuring out whether we are in an option,
/// and if so completing it.
///
- /// \param[in/out] request
+ /// \param[in,out] request
/// The completion request that we need to act upon.
///
/// \param[in] interpreter
diff --git a/lldb/include/lldb/Symbol/Block.h b/lldb/include/lldb/Symbol/Block.h
index 36d0944f12b0..c2760dddf45f 100644
--- a/lldb/include/lldb/Symbol/Block.h
+++ b/lldb/include/lldb/Symbol/Block.h
@@ -57,12 +57,6 @@ class Block : public UserID, public SymbolContextScope {
/// depth parsing. Common values would be the index into a
/// table, or an offset into the debug information.
///
- /// \param[in] depth
- /// The integer depth of this block in the block list hierarchy.
- ///
- /// \param[in] block_list
- /// The block list that this object belongs to.
- ///
/// \see BlockList
Block(lldb::user_id_t uid);
@@ -77,14 +71,6 @@ class Block : public UserID, public SymbolContextScope {
void AddChild(const lldb::BlockSP &child_block_sp);
/// Add a new offset range to this block.
- ///
- /// \param[in] start_offset
- /// An offset into this Function's address range that
- /// describes the start address of a range for this block.
- ///
- /// \param[in] end_offset
- /// An offset into this Function's address range that
- /// describes the end address of a range for this block.
void AddRange(const Range &range);
void FinalizeRanges();
@@ -232,10 +218,6 @@ class Block : public UserID, public SymbolContextScope {
/// Get the variable list for this block and optionally all child blocks if
/// \a get_child_variables is \b true.
///
- /// \param[in] get_child_variables
- /// If \b true, all variables from all child blocks will be
- /// added to the variable list.
- ///
/// \param[in] can_create
/// If \b true, the variables can be parsed if they already
/// haven't been, else the current state of the block will be
@@ -243,11 +225,9 @@ class Block : public UserID, public SymbolContextScope {
/// to see the current state of what has been parsed up to this
/// point.
///
- /// \param[in] add_inline_child_block_variables
- /// If this is \b false, no child variables of child blocks
- /// that are inlined functions will be gotten. If \b true then
- /// all child variables will be added regardless of whether they
- /// come from inlined functions or not.
+ /// \param[in] get_child_block_variables
+ /// If \b true, all variables from all child blocks will be
+ /// added to the variable list.
///
/// \return
/// A variable list shared pointer that contains all variables
diff --git a/lldb/include/lldb/Symbol/CompileUnit.h b/lldb/include/lldb/Symbol/CompileUnit.h
index 4a6306fcf4a7..b206e6fde9ee 100644
--- a/lldb/include/lldb/Symbol/CompileUnit.h
+++ b/lldb/include/lldb/Symbol/CompileUnit.h
@@ -44,7 +44,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>,
/// convert into a FileSpec, the SymbolFile plug-in supplied \a uid, and the
/// source language type.
///
- /// \param[in] module
+ /// \param[in] module_sp
/// The parent module that owns this compile unit. This value
/// must be a valid pointer value.
///
@@ -82,7 +82,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>,
/// convert into a FileSpec, the SymbolFile plug-in supplied \a uid, and the
/// source language type.
///
- /// \param[in] module
+ /// \param[in] module_sp
/// The parent module that owns this compile unit. This value
/// must be a valid pointer value.
///
@@ -241,7 +241,7 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>,
/// compilation unit. Recursively also descends into the referenced external
/// modules of any encountered compilation unit.
///
- /// \param[in] lambda
+ /// \param[in] f
/// The lambda that should be applied to every module.
void ForEachExternalModule(llvm::function_ref<void(lldb::ModuleSP)> f);
diff --git a/lldb/include/lldb/Symbol/Declaration.h b/lldb/include/lldb/Symbol/Declaration.h
index 4b8ece02f9c7..a751d6ba039f 100644
--- a/lldb/include/lldb/Symbol/Declaration.h
+++ b/lldb/include/lldb/Symbol/Declaration.h
@@ -92,9 +92,9 @@ class Declaration {
/// The Right Hand Side const Declaration object reference.
///
/// \return
- /// \li -1 if lhs < rhs
- /// \li 0 if lhs == rhs
- /// \li 1 if lhs > rhs
+ /// -1 if lhs < rhs
+ /// 0 if lhs == rhs
+ /// 1 if lhs > rhs
static int Compare(const Declaration &lhs, const Declaration &rhs);
/// Checks if this object has the same file and line as another declaration
diff --git a/lldb/include/lldb/Symbol/Function.h b/lldb/include/lldb/Symbol/Function.h
index 1b23a99373ca..1fef4f0177e3 100644
--- a/lldb/include/lldb/Symbol/Function.h
+++ b/lldb/include/lldb/Symbol/Function.h
@@ -68,9 +68,9 @@ class FunctionInfo {
/// The Right Hand Side const FunctionInfo object reference.
///
/// \return
- /// \li -1 if lhs < rhs
- /// \li 0 if lhs == rhs
- /// \li 1 if lhs > rhs
+ /// -1 if lhs < rhs
+ /// 0 if lhs == rhs
+ /// 1 if lhs > rhs
static int Compare(const FunctionInfo &lhs, const FunctionInfo &rhs);
/// Dump a description of this object to a Stream.
@@ -183,9 +183,9 @@ class InlineFunctionInfo : public FunctionInfo {
/// reference.
///
/// \return
- /// \li -1 if lhs < rhs
- /// \li 0 if lhs == rhs
- /// \li 1 if lhs > rhs
+ /// -1 if lhs < rhs
+ /// 0 if lhs == rhs
+ /// 1 if lhs > rhs
int Compare(const InlineFunctionInfo &lhs, const InlineFunctionInfo &rhs);
/// Dump a description of this object to a Stream.
diff --git a/lldb/include/lldb/Symbol/LineEntry.h b/lldb/include/lldb/Symbol/LineEntry.h
index fe97a78e3ed4..32ffef72ee5e 100644
--- a/lldb/include/lldb/Symbol/LineEntry.h
+++ b/lldb/include/lldb/Symbol/LineEntry.h
@@ -42,11 +42,6 @@ struct LineEntry {
/// \param[in] s
/// The stream to which to dump the object description.
///
- /// \param[in] comp_unit
- /// The compile unit object that contains the support file
- /// list so the line entry can dump the file name (since this
- /// object contains a file index into the support file list).
- ///
/// \param[in] show_file
/// If \b true, display the filename with the line entry which
/// requires that the compile unit object \a comp_unit be a
@@ -75,11 +70,6 @@ struct LineEntry {
/// \param[in] s
/// The stream to which to dump the object description.
///
- /// \param[in] comp_unit
- /// The compile unit object that contains the support file
- /// list so the line entry can dump the file name (since this
- /// object contains a file index into the support file list).
- ///
/// \return
/// Returns \b true if the file and line were properly dumped,
/// \b false otherwise.
@@ -102,9 +92,9 @@ struct LineEntry {
/// The Right Hand Side const LineEntry object reference.
///
/// \return
- /// \li -1 if lhs < rhs
- /// \li 0 if lhs == rhs
- /// \li 1 if lhs > rhs
+ /// -1 if lhs < rhs
+ /// 0 if lhs == rhs
+ /// 1 if lhs > rhs
static int Compare(const LineEntry &lhs, const LineEntry &rhs);
/// Give the range for this LineEntry + any additional LineEntries for this
@@ -143,7 +133,6 @@ struct LineEntry {
///
/// \param[in] target_sp
/// Shared pointer to the target this LineEntry belongs to.
-
void ApplyFileMappings(lldb::TargetSP target_sp);
// Member variables.
diff --git a/lldb/include/lldb/Symbol/LineTable.h b/lldb/include/lldb/Symbol/LineTable.h
index d24cc35e10f3..043f3eb895cb 100644
--- a/lldb/include/lldb/Symbol/LineTable.h
+++ b/lldb/include/lldb/Symbol/LineTable.h
@@ -135,8 +135,8 @@ class LineTable {
/// If true, match only if you find a line entry exactly matching \a line.
/// If false, return the closest line entry greater than \a line.
///
- /// \param[out] line_entry
- /// A reference to a line entry object that will get a copy of
+ /// \param[out] line_entry_ptr
+ /// A pointer to a line entry object that will get a copy of
/// the line entry if \b true is returned, otherwise \a
/// line_entry is left untouched.
///
@@ -194,16 +194,6 @@ class LineTable {
size_t GetContiguousFileAddressRanges(FileAddressRanges &file_ranges,
bool append);
- /// Given a file range link map, relink the current line table and return a
- /// fixed up line table.
- ///
- /// \param[out] file_range_map
- /// A collection of file ranges that maps to new file ranges
- /// that will be used when linking the line table.
- ///
- /// \return
- /// A new line table if at least one line table entry was able
- /// to be mapped.
typedef RangeDataVector<lldb::addr_t, lldb::addr_t, lldb::addr_t>
FileRangeMap;
diff --git a/lldb/include/lldb/Symbol/ObjectFile.h b/lldb/include/lldb/Symbol/ObjectFile.h
index 4d04f23a8286..841a38e5b15a 100644
--- a/lldb/include/lldb/Symbol/ObjectFile.h
+++ b/lldb/include/lldb/Symbol/ObjectFile.h
@@ -130,7 +130,7 @@ class ObjectFile : public std::enable_shared_from_this<ObjectFile>,
/// ObjectFile plug-in interface and returns the first instance that can
/// parse the file.
///
- /// \param[in] module
+ /// \param[in] module_sp
/// The parent module that owns this object file.
///
/// \param[in] file_spec
@@ -158,7 +158,7 @@ class ObjectFile : public std::enable_shared_from_this<ObjectFile>,
/// ObjectFile plug-in interface and returns the first instance that can
/// parse the file.
///
- /// \param[in] module
+ /// \param[in] module_sp
/// The parent module that owns this object file.
///
/// \param[in] process_sp
@@ -356,13 +356,6 @@ class ObjectFile : public std::enable_shared_from_this<ObjectFile>,
/// Frees the symbol table.
///
/// This function should only be used when an object file is
- ///
- /// \param[in] flags
- /// eSymtabFromUnifiedSectionList: Whether to clear symbol table
- /// for unified module section list, or object file.
- ///
- /// \return
- /// The symbol table for this object file.
virtual void ClearSymtab();
/// Gets the UUID for this object file.
@@ -487,8 +480,8 @@ class ObjectFile : public std::enable_shared_from_this<ObjectFile>,
/// \return
/// Returns the identifier string if one exists, else an empty
/// string.
- virtual std::string GetIdentifierString () {
- return std::string();
+ virtual std::string GetIdentifierString () {
+ return std::string();
}
/// When the ObjectFile is a core file, lldb needs to locate the "binary" in
@@ -652,8 +645,6 @@ class ObjectFile : public std::enable_shared_from_this<ObjectFile>,
///
/// \param[in] target
/// Target where to load.
- ///
- /// \return
virtual std::vector<LoadableData> GetLoadableData(Target &target);
/// Creates a plugin-specific call frame info
diff --git a/lldb/include/lldb/Symbol/SymbolContext.h b/lldb/include/lldb/Symbol/SymbolContext.h
index 34735ab95578..4c7b727fe618 100644
--- a/lldb/include/lldb/Symbol/SymbolContext.h
+++ b/lldb/include/lldb/Symbol/SymbolContext.h
@@ -51,7 +51,7 @@ class SymbolContext {
///
/// Initialize all pointer to the specified values.
///
- /// \param[in] module
+ /// \param[in] module_sp
/// A Module pointer to the module for this context.
///
/// \param[in] comp_unit
@@ -267,11 +267,6 @@ class SymbolContext {
/// For instance, if the symbol context contains an inlined block, it will
/// return the inlined function name.
///
- /// \param[in] prefer_mangled
- /// if \btrue, then the mangled name will be returned if there
- /// is one. Otherwise the unmangled name will be returned if it
- /// is available.
- ///
/// \return
/// The name of the function represented by this symbol context.
ConstString GetFunctionName(
@@ -286,14 +281,6 @@ class SymbolContext {
/// ModuleList::FindFunctions(...) call in order to get the correct line
/// table information for the symbol context. it will return the inlined
/// function name.
- ///
- /// \param[in] prefer_mangled
- /// if \btrue, then the mangled name will be returned if there
- /// is one. Otherwise the unmangled name will be returned if it
- /// is available.
- ///
- /// \return
- /// The name of the function represented by this symbol context.
LineEntry GetFunctionStartLineEntry() const;
/// Find the block containing the inlined block that contains this block.
@@ -307,13 +294,13 @@ class SymbolContext {
/// \param[out] next_frame_sc
/// A new symbol context that does what the title says it does.
///
- /// \param[out] next_frame_addr
+ /// \param[out] inlined_frame_addr
/// This is what you should report as the PC in \a next_frame_sc.
///
/// \return
/// \b true if this SymbolContext specifies a block contained in an
/// inlined block. If this returns \b true, \a next_frame_sc and
- /// \a next_frame_addr will be filled in correctly.
+ /// \a inlined_frame_addr will be filled in correctly.
bool GetParentOfInlinedScope(const Address &curr_frame_pc,
SymbolContext &next_frame_sc,
Address &inlined_frame_addr) const;
diff --git a/lldb/include/lldb/Target/Platform.h b/lldb/include/lldb/Target/Platform.h
index 6f643df53d1e..72b6be21b770 100644
--- a/lldb/include/lldb/Target/Platform.h
+++ b/lldb/include/lldb/Target/Platform.h
@@ -380,9 +380,6 @@ class Platform : public PluginInterface {
/// attached to the process, or an empty shared pointer with an appropriate
/// error.
///
- /// \param[in] pid
- /// The process ID that we should attempt to attach to.
- ///
/// \return
/// An appropriate ProcessSP containing a valid shared pointer
/// to the default Process subclass for the platform that is
@@ -777,7 +774,7 @@ class Platform : public PluginInterface {
/// given an install name and a set (e.g. DYLD_LIBRARY_PATH provided) of
/// alternate paths.
///
- /// \param[in] path_list
+ /// \param[in] paths
/// The list of paths to use to search for the library. First
/// match wins.
///
@@ -788,7 +785,7 @@ class Platform : public PluginInterface {
/// \param[out] loaded_path
/// If non-null, the path to the dylib that was successfully loaded
/// is stored in this path.
- ///
+ ///
/// \return
/// A token that represents the shared library which can be
/// passed to UnloadImage. A value of
diff --git a/lldb/include/lldb/Target/Process.h b/lldb/include/lldb/Target/Process.h
index a4ef1cc40414..b06dcbd74f11 100644
--- a/lldb/include/lldb/Target/Process.h
+++ b/lldb/include/lldb/Target/Process.h
@@ -520,14 +520,6 @@ class Process : public std::enable_shared_from_this<Process>,
/// Process plug-in interface and returns the first instance that can debug
/// the file.
///
- /// \param[in] module_sp
- /// The module shared pointer that this process will debug.
- ///
- /// \param[in] plugin_name
- /// If nullptr, select the best plug-in for the binary. If non-nullptr
- /// then look for a plugin whose PluginInfo's name matches
- /// this string.
- ///
/// \see Process::CanDebug ()
static lldb::ProcessSP FindPlugin(lldb::TargetSP target_sp,
llvm::StringRef plugin_name,
@@ -714,8 +706,8 @@ class Process : public std::enable_shared_from_this<Process>,
/// char *) will be called to actually do the attach. If DoAttach returns \b
/// true, then Process::DidAttach() will be called.
///
- /// \param[in] pid
- /// The process ID that we should attempt to attach to.
+ /// \param[in] attach_info
+ /// The process attach info.
///
/// \return
/// Returns \a pid if attaching was successful, or
@@ -1722,8 +1714,9 @@ class Process : public std::enable_shared_from_this<Process>,
/// lldb,
/// just not by the process itself.
///
- /// \param[in/out] error
+ /// \param[in,out] error
/// An error object to fill in if things go wrong.
+ ///
/// \return
/// The address of the allocated buffer in the process, or
/// LLDB_INVALID_ADDRESS if the allocation failed.
@@ -2171,7 +2164,7 @@ class Process : public std::enable_shared_from_this<Process>,
/// WaitFor* calls above. Be sure to call RestoreProcessEvents when you are
/// done.
///
- /// \param[in] listener
+ /// \param[in] listener_sp
/// This is the new listener to whom all process events will be delivered.
///
/// \return
@@ -2272,7 +2265,7 @@ class Process : public std::enable_shared_from_this<Process>,
void ClearPreResumeAction(PreResumeActionCallback callback, void *baton);
ProcessRunLock &GetRunLock();
-
+
bool CurrentThreadIsPrivateStateThread();
virtual Status SendEventData(const char *data) {
@@ -2372,7 +2365,7 @@ class Process : public std::enable_shared_from_this<Process>,
/// The StructuredData type name as previously discovered by
/// the Process-derived instance.
///
- /// \param[in] config
+ /// \param[in] config_sp
/// Configuration data for the feature being enabled. This config
/// data, which may be null, will be passed along to the feature
/// to process. The feature will dictate whether this is a dictionary,
@@ -2750,7 +2743,7 @@ class Process : public std::enable_shared_from_this<Process>,
StructuredDataPluginMap m_structured_data_plugin_map;
enum { eCanJITDontKnow = 0, eCanJITYes, eCanJITNo } m_can_jit;
-
+
std::unique_ptr<UtilityFunction> m_dlopen_utility_func_up;
llvm::once_flag m_dlopen_utility_func_flag_once;
diff --git a/lldb/include/lldb/Target/StackFrame.h b/lldb/include/lldb/Target/StackFrame.h
index d2e5795162cf..1c6a2b481160 100644
--- a/lldb/include/lldb/Target/StackFrame.h
+++ b/lldb/include/lldb/Target/StackFrame.h
@@ -99,8 +99,6 @@ class StackFrame : public ExecutionContextScope,
/// \param [in] pc
/// The current pc value of this stack frame.
///
- /// \param [in] frame_kind
- ///
/// \param [in] sc_ptr
/// Optionally seed the StackFrame with the SymbolContext information that
/// has
@@ -289,18 +287,18 @@ class StackFrame : public ExecutionContextScope,
llvm::StringRef var_expr, lldb::DynamicValueType use_dynamic,
uint32_t options, lldb::VariableSP &var_sp, Status &error);
- /// Determine whether this StackFrame has debug information available or not
+ /// Determine whether this StackFrame has debug information available or not.
///
/// \return
- // true if debug information is available for this frame (function,
- // compilation unit, block, etc.)
+ /// true if debug information is available for this frame (function,
+ /// compilation unit, block, etc.)
bool HasDebugInformation();
/// Return the disassembly for the instructions of this StackFrame's
/// function as a single C string.
///
/// \return
- // C string with the assembly instructions for this function.
+ /// C string with the assembly instructions for this function.
const char *Disassemble();
/// Print a description for this frame using the frame-format formatter
@@ -407,7 +405,7 @@ class StackFrame : public ExecutionContextScope,
/// is sufficient. One of the DynamicValueType enumerated values.
///
/// \return
- // A ValueObject for this variable.
+ /// A ValueObject for this variable.
lldb::ValueObjectSP
GetValueObjectForFrameVariable(const lldb::VariableSP &variable_sp,
lldb::DynamicValueType use_dynamic);
@@ -424,7 +422,7 @@ class StackFrame : public ExecutionContextScope,
/// is sufficient. One of the DynamicValueType enumerated values.
///
/// \return
- // A ValueObject for this variable.
+ /// A ValueObject for this variable.
lldb::ValueObjectSP TrackGlobalVariable(const lldb::VariableSP &variable_sp,
lldb::DynamicValueType use_dynamic);
diff --git a/lldb/include/lldb/Target/Target.h b/lldb/include/lldb/Target/Target.h
index e465046959f2..96c5a580037b 100644
--- a/lldb/include/lldb/Target/Target.h
+++ b/lldb/include/lldb/Target/Target.h
@@ -906,8 +906,8 @@ class Target : public std::enable_shared_from_this<Target>,
/// The target call at present just consults the Platform's call of the
/// same name.
///
- /// \param[in] module_sp
- /// A shared pointer reference to the module that checked.
+ /// \param[in] module_spec
+ /// Path to the module.
///
/// \return \b true if the module should be excluded, \b false otherwise.
bool ModuleIsExcludedForUnconstrainedSearches(const FileSpec &module_spec);
diff --git a/lldb/include/lldb/Target/TargetList.h b/lldb/include/lldb/Target/TargetList.h
index ece0705ae71c..50a7a321ead1 100644
--- a/lldb/include/lldb/Target/TargetList.h
+++ b/lldb/include/lldb/Target/TargetList.h
@@ -55,12 +55,12 @@ class TargetList : public Broadcaster {
/// \param[in] debugger
/// The debugger to associate this target with
///
- /// \param[in] file_spec
+ /// \param[in] user_exe_path
/// The main executable file for a debug target. This value
- /// can be nullptr and the file can be set later using:
+ /// can be empty and the file can be set later using:
/// Target::SetExecutableModule (ModuleSP&)
///
- /// \param[in] triple_cstr
+ /// \param[in] triple_str
/// A target triple string to be used for the target. This can
/// be nullptr if the triple is not known or when attaching to a
/// process.
diff --git a/lldb/include/lldb/Target/Thread.h b/lldb/include/lldb/Target/Thread.h
index 7c5ff6093baf..cdc8d39251c6 100644
--- a/lldb/include/lldb/Target/Thread.h
+++ b/lldb/include/lldb/Target/Thread.h
@@ -128,10 +128,6 @@ class Thread : public std::enable_shared_from_this<Thread>,
/// Constructor
///
- /// \param [in] process
- ///
- /// \param [in] tid
- ///
/// \param [in] use_invalid_index_id
/// Optional parameter, defaults to false. The only subclass that
/// is likely to set use_invalid_index_id == true is the HistoryThread
@@ -760,6 +756,8 @@ class Thread : public std::enable_shared_from_this<Thread>,
/// \b true if we will stop other threads while we single step this one.
///
/// \param[in] stop_vote
+ /// See standard meanings for the stop & run votes in ThreadPlan.h.
+ ///
/// \param[in] run_vote
/// See standard meanings for the stop & run votes in ThreadPlan.h.
///
@@ -807,11 +805,13 @@ class Thread : public std::enable_shared_from_this<Thread>,
/// \b true if we will stop other threads while we single step this one.
///
/// \param[in] stop_vote
+ /// See standard meanings for the stop & run votes in ThreadPlan.h.
///
/// \param[in] run_vote
/// See standard meanings for the stop & run votes in ThreadPlan.h.
///
/// \param[in] frame_idx
+ /// The fame index.
///
/// \param[out] status
/// A status with an error if queuing failed.
@@ -899,7 +899,7 @@ class Thread : public std::enable_shared_from_this<Thread>,
virtual lldb::ThreadPlanSP
QueueThreadPlanForStepScripted(bool abort_other_plans, const char *class_name,
- StructuredData::ObjectSP extra_args_sp,
+ StructuredData::ObjectSP extra_args_sp,
bool stop_other_threads, Status &status);
// Thread Plan accessors:
@@ -1004,7 +1004,7 @@ class Thread : public std::enable_shared_from_this<Thread>,
/// including the plan in that matches \a thread_index counting only
/// the non-Private plans.
///
- /// \param[in] up_to_plan_sp
+ /// \param[in] thread_index
/// Discard all plans up to and including this user plan given by this
/// index.
///
@@ -1102,9 +1102,9 @@ class Thread : public std::enable_shared_from_this<Thread>,
// right even if you have not calculated this yourself, or if it disagrees
// with what you might have calculated.
virtual lldb::StopInfoSP GetPrivateStopInfo();
-
+
// Calculate the stop info that will be shown to lldb clients. For instance,
- // a "step out" is implemented by running to a breakpoint on the function
+ // a "step out" is implemented by running to a breakpoint on the function
// return PC, so the process plugin initially sets the stop info to a
// StopInfoBreakpoint. But once we've run the ShouldStop machinery, we
// discover that there's a completed ThreadPlanStepOut, and that's really
diff --git a/lldb/include/lldb/Utility/ConstString.h b/lldb/include/lldb/Utility/ConstString.h
index 9a9ee458239f..74750459d16f 100644
--- a/lldb/include/lldb/Utility/ConstString.h
+++ b/lldb/include/lldb/Utility/ConstString.h
@@ -147,8 +147,8 @@ class ConstString {
/// Another string object to compare this object to.
///
/// \return
- /// \li \b true if this object is equal to \a rhs.
- /// \li \b false if this object is not equal to \a rhs.
+ /// true if this object is equal to \a rhs.
+ /// false if this object is not equal to \a rhs.
bool operator==(ConstString rhs) const {
// We can do a pointer compare to compare these strings since they must
// come from the same pool in order to be equal.
@@ -166,8 +166,8 @@ class ConstString {
/// Another string object to compare this object to.
///
/// \return
- /// \li \b true if this object is equal to \a rhs.
- /// \li \b false if this object is not equal to \a rhs.
+ /// \b true if this object is equal to \a rhs.
+ /// \b false if this object is not equal to \a rhs.
bool operator==(const char *rhs) const {
// ConstString
diff erentiates between empty strings and nullptr strings, but
// StringRef doesn't. Therefore we have to do this check manually now.
@@ -189,8 +189,8 @@ class ConstString {
/// Another string object to compare this object to.
///
/// \return
- /// \li \b true if this object is not equal to \a rhs.
- /// \li \b false if this object is equal to \a rhs.
+ /// \b true if this object is not equal to \a rhs.
+ /// \b false if this object is equal to \a rhs.
bool operator!=(ConstString rhs) const {
return m_string != rhs.m_string;
}
@@ -328,15 +328,15 @@ class ConstString {
/// Test for empty string.
///
/// \return
- /// \li \b true if the contained string is empty.
- /// \li \b false if the contained string is not empty.
+ /// \b true if the contained string is empty.
+ /// \b false if the contained string is not empty.
bool IsEmpty() const { return m_string == nullptr || m_string[0] == '\0'; }
/// Test for null string.
///
/// \return
- /// \li \b true if there is no string associated with this instance.
- /// \li \b false if there is a string associated with this instance.
+ /// \b true if there is no string associated with this instance.
+ /// \b false if there is a string associated with this instance.
bool IsNull() const { return m_string == nullptr; }
/// Set the C string value.
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp b/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
index 1422911d6546..858a5b7d0673 100644
--- a/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
+++ b/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
@@ -696,10 +696,7 @@ class CodeComplete : public CodeCompleteConsumer {
public:
/// Constructs a CodeComplete consumer that can be attached to a Sema.
- /// \param[out] matches
- /// The list of matches that the lldb completion API expects as a result.
- /// This may already contain matches, so it's only allowed to append
- /// to this variable.
+ ///
/// \param[out] expr
/// The whole expression string that we are currently parsing. This
/// string needs to be equal to the input the user typed, and NOT the
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionVariable.h b/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionVariable.h
index eb7f74f20a20..0e6de28ee4df 100644
--- a/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionVariable.h
+++ b/lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionVariable.h
@@ -74,9 +74,6 @@ class ClangExpressionVariable : public ExpressionVariable {
/// Finds a variable by NamedDecl in the list.
///
- /// \param[in] name
- /// The name of the requested variable.
- ///
/// \return
/// The variable requested, or NULL if that variable is not in the list.
static ClangExpressionVariable *
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangFunctionCaller.h b/lldb/source/Plugins/ExpressionParser/Clang/ClangFunctionCaller.h
index 45bd1f410a67..abfd4e52ef6f 100644
--- a/lldb/source/Plugins/ExpressionParser/Clang/ClangFunctionCaller.h
+++ b/lldb/source/Plugins/ExpressionParser/Clang/ClangFunctionCaller.h
@@ -104,8 +104,8 @@ class ClangFunctionCaller : public FunctionCaller {
/// \param[in] ast_context
/// The AST context to evaluate argument types in.
///
- /// \param[in] return_qualtype
- /// An opaque Clang QualType for the function result. Should be
+ /// \param[in] return_type
+ /// A compiler type for the function result. Should be
/// defined in ast_context.
///
/// \param[in] function_address
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/ClangUserExpression.h b/lldb/source/Plugins/ExpressionParser/Clang/ClangUserExpression.h
index b8506a608de7..00cbffa7fd6f 100644
--- a/lldb/source/Plugins/ExpressionParser/Clang/ClangUserExpression.h
+++ b/lldb/source/Plugins/ExpressionParser/Clang/ClangUserExpression.h
@@ -96,7 +96,7 @@ class ClangUserExpression : public LLVMUserExpression {
/// \param[in] expr
/// The expression to parse.
///
- /// \param[in] expr_prefix
+ /// \param[in] prefix
/// If non-NULL, a C string containing translation-unit level
/// definitions to be included when the expression is parsed.
///
diff --git a/lldb/source/Plugins/ExpressionParser/Clang/IRDynamicChecks.h b/lldb/source/Plugins/ExpressionParser/Clang/IRDynamicChecks.h
index 60c0691b21c1..5b9c8007ab76 100644
--- a/lldb/source/Plugins/ExpressionParser/Clang/IRDynamicChecks.h
+++ b/lldb/source/Plugins/ExpressionParser/Clang/IRDynamicChecks.h
@@ -76,10 +76,6 @@ class IRDynamicChecks : public llvm::ModulePass {
///
/// \param[in] func_name
/// The name of the function to prepare for execution in the target.
- ///
- /// \param[in] decl_map
- /// The mapping used to look up entities in the target process. In
- /// this case, used to find objc_msgSend
IRDynamicChecks(ClangDynamicCheckerFunctions &checker_functions,
const char *func_name = "$__lldb_expr");
diff --git a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h
index 6539286b1a45..11fd40bce44f 100644
--- a/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h
+++ b/lldb/source/Plugins/Process/gdb-remote/GDBRemoteCommunicationClient.h
@@ -89,7 +89,7 @@ class GDBRemoteCommunicationClient : public GDBRemoteClientBase {
/// Sends a GDB remote protocol 'A' packet that delivers program
/// arguments to the remote server.
///
- /// \param[in] argv
+ /// \param[in] launch_info
/// A NULL terminated array of const C strings to use as the
/// arguments.
///
@@ -155,7 +155,7 @@ class GDBRemoteCommunicationClient : public GDBRemoteClientBase {
/// 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] file_spec
/// The path to use for stdin/out/err
///
/// \return
diff --git a/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.h b/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.h
index 7adee1b356ce..70a2bdce519c 100644
--- a/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.h
+++ b/lldb/source/Plugins/SymbolFile/DWARF/SymbolFileDWARFDebugMap.h
@@ -348,8 +348,8 @@ class SymbolFileDWARFDebugMap : public lldb_private::SymbolFile {
/// \param[in] oso_symfile
/// The DWARF symbol file that produced the \a line_table
///
- /// \param[in] addr
- /// A section offset address from a .o file
+ /// \param[in] line_table
+ /// A pointer to the line table.
///
/// \return
/// Returns a valid line table full of linked addresses, or NULL
diff --git a/lldb/tools/lldb-vscode/LLDBUtils.h b/lldb/tools/lldb-vscode/LLDBUtils.h
index 4e0da17d97b2..82c17eb3cdc6 100644
--- a/lldb/tools/lldb-vscode/LLDBUtils.h
+++ b/lldb/tools/lldb-vscode/LLDBUtils.h
@@ -113,8 +113,8 @@ 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
-/// The LLDB stack frame object generate the ID for
+/// \param[in] bp_loc
+/// The LLDB break point location.
///
/// \return
/// A unique integer that allows us to easily find the right
More information about the lldb-commits
mailing list