[Lldb-commits] [lldb] [lldb][docs][NFC] Fix some doxygen comments (PR #132910)
via lldb-commits
lldb-commits at lists.llvm.org
Tue Mar 25 03:17:55 PDT 2025
llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT-->
@llvm/pr-subscribers-lldb
Author: Michael Buch (Michael137)
<details>
<summary>Changes</summary>
These weren't rendering properly (mostly mis-use the syntax for commenting member variables).
---
Full diff: https://github.com/llvm/llvm-project/pull/132910.diff
8 Files Affected:
- (modified) lldb/include/lldb/Core/Mangled.h (+3-3)
- (modified) lldb/include/lldb/Core/Module.h (+2-2)
- (modified) lldb/include/lldb/Interpreter/CommandInterpreter.h (+6-6)
- (modified) lldb/include/lldb/Symbol/SymbolFile.h (+6-6)
- (modified) lldb/include/lldb/Target/Target.h (+3-3)
- (modified) lldb/include/lldb/ValueObject/ValueObjectVariable.h (+3-2)
- (modified) lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.cpp (-4)
- (modified) lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.h (+5-5)
``````````diff
diff --git a/lldb/include/lldb/Core/Mangled.h b/lldb/include/lldb/Core/Mangled.h
index 9ca28917ccffa..5988d919a89b8 100644
--- a/lldb/include/lldb/Core/Mangled.h
+++ b/lldb/include/lldb/Core/Mangled.h
@@ -276,11 +276,11 @@ class Mangled {
void Encode(DataEncoder &encoder, ConstStringTable &strtab) const;
private:
- ///< The mangled version of the name.
+ /// The mangled version of the name.
ConstString m_mangled;
- ///< Mutable so we can get it on demand with
- ///< a const version of this object.
+ /// Mutable so we can get it on demand with
+ /// a const version of this object.
mutable ConstString m_demangled;
};
diff --git a/lldb/include/lldb/Core/Module.h b/lldb/include/lldb/Core/Module.h
index 9aa05ed3eb074..1ad67d6747850 100644
--- a/lldb/include/lldb/Core/Module.h
+++ b/lldb/include/lldb/Core/Module.h
@@ -951,8 +951,8 @@ class Module : public std::enable_shared_from_this<Module>,
/// names we are looking for
lldb::FunctionNameType m_name_type_mask = lldb::eFunctionNameTypeNone;
- ///< If \b true, then demangled names that match will need to contain
- ///< "m_name" in order to be considered a match
+ /// If \b true, then demangled names that match will need to contain
+ /// "m_name" in order to be considered a match
bool m_match_name_after_lookup = false;
};
diff --git a/lldb/include/lldb/Interpreter/CommandInterpreter.h b/lldb/include/lldb/Interpreter/CommandInterpreter.h
index d5425788fe1c9..b65edcf68b251 100644
--- a/lldb/include/lldb/Interpreter/CommandInterpreter.h
+++ b/lldb/include/lldb/Interpreter/CommandInterpreter.h
@@ -246,12 +246,12 @@ class CommandInterpreter : public Broadcaster,
};
enum CommandTypes {
- eCommandTypesBuiltin = 0x0001, //< native commands such as "frame"
- eCommandTypesUserDef = 0x0002, //< scripted commands
- eCommandTypesUserMW = 0x0004, //< multiword commands (command containers)
- eCommandTypesAliases = 0x0008, //< aliases such as "po"
- eCommandTypesHidden = 0x0010, //< commands prefixed with an underscore
- eCommandTypesAllThem = 0xFFFF //< all commands
+ eCommandTypesBuiltin = 0x0001, ///< native commands such as "frame"
+ eCommandTypesUserDef = 0x0002, ///< scripted commands
+ eCommandTypesUserMW = 0x0004, ///< multiword commands (command containers)
+ eCommandTypesAliases = 0x0008, ///< aliases such as "po"
+ eCommandTypesHidden = 0x0010, ///< commands prefixed with an underscore
+ eCommandTypesAllThem = 0xFFFF ///< all commands
};
using CommandReturnObjectCallback =
diff --git a/lldb/include/lldb/Symbol/SymbolFile.h b/lldb/include/lldb/Symbol/SymbolFile.h
index 837b922ae77f7..dd056035d546e 100644
--- a/lldb/include/lldb/Symbol/SymbolFile.h
+++ b/lldb/include/lldb/Symbol/SymbolFile.h
@@ -212,13 +212,13 @@ class SymbolFile : public PluginInterface {
struct ArrayInfo {
int64_t first_index = 0;
- ///< Each entry belongs to a distinct DW_TAG_subrange_type.
- ///< For multi-dimensional DW_TAG_array_types we would have
- ///< an entry for each dimension. An entry represents the
- ///< optional element count of the subrange.
+ /// Each entry belongs to a distinct DW_TAG_subrange_type.
+ /// For multi-dimensional DW_TAG_array_types we would have
+ /// an entry for each dimension. An entry represents the
+ /// optional element count of the subrange.
///
- ///< The order of entries follows the order of the DW_TAG_subrange_type
- ///< children of this DW_TAG_array_type.
+ /// The order of entries follows the order of the DW_TAG_subrange_type
+ /// children of this DW_TAG_array_type.
llvm::SmallVector<std::optional<uint64_t>, 1> element_orders;
uint32_t byte_stride = 0;
uint32_t bit_stride = 0;
diff --git a/lldb/include/lldb/Target/Target.h b/lldb/include/lldb/Target/Target.h
index 98273fb7e1c97..d1748d5385b86 100644
--- a/lldb/include/lldb/Target/Target.h
+++ b/lldb/include/lldb/Target/Target.h
@@ -510,9 +510,9 @@ class EvaluateExpressionOptions {
mutable std::string m_pound_line_file;
mutable uint32_t m_pound_line_line = 0;
- ///< During expression evaluation, any SymbolContext in this list will be
- ///< used for symbol/function lookup before any other context (except for
- ///< the module corresponding to the current frame).
+ /// During expression evaluation, any SymbolContext in this list will be
+ /// used for symbol/function lookup before any other context (except for
+ /// the module corresponding to the current frame).
SymbolContextList m_preferred_lookup_contexts;
};
diff --git a/lldb/include/lldb/ValueObject/ValueObjectVariable.h b/lldb/include/lldb/ValueObject/ValueObjectVariable.h
index 16030cd4edbac..5a791a0f1d83a 100644
--- a/lldb/include/lldb/ValueObject/ValueObjectVariable.h
+++ b/lldb/include/lldb/ValueObject/ValueObjectVariable.h
@@ -75,8 +75,9 @@ class ValueObjectVariable : public ValueObject {
/// The variable that this value object is based upon.
lldb::VariableSP m_variable_sp;
- ///< The value that DWARFExpression resolves this variable to before we patch
- ///< it up.
+
+ /// The value that DWARFExpression resolves this variable to before we patch
+ /// it up.
Value m_resolved_value;
private:
diff --git a/lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.cpp b/lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.cpp
index 3cbd03b24297a..b724083e1e3dd 100644
--- a/lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.cpp
+++ b/lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.cpp
@@ -13,10 +13,6 @@
namespace lldb_private {
-///< On Darwin, if LLDB loaded libclang_rt, it's coming from a locally built
-///< compiler-rt, and we should prefer it in favour of the system sanitizers.
-///< This helper searches the target for such a dylib. Returns nullptr if no
-///< such dylib was found.
lldb::ModuleSP GetPreferredAsanModule(const Target &target) {
lldb::ModuleSP module;
llvm::Regex pattern(R"(libclang_rt\.asan_.*_dynamic\.dylib)");
diff --git a/lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.h b/lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.h
index 813a0c107989e..425f0a2d35640 100644
--- a/lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.h
+++ b/lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.h
@@ -15,11 +15,11 @@ namespace lldb_private {
class Target;
-///< On Darwin, if LLDB loaded libclang_rt, it's coming from a locally built
-///< compiler-rt, and we should prefer it in favour of the system sanitizers
-///< when running InstrumentationRuntime utility expressions that use symbols
-///< from the sanitizer libraries. This helper searches the target for such a
-///< dylib. Returns nullptr if no such dylib was found.
+/// On Darwin, if LLDB loaded libclang_rt, it's coming from a locally built
+/// compiler-rt, and we should prefer it in favour of the system sanitizers
+/// when running InstrumentationRuntime utility expressions that use symbols
+/// from the sanitizer libraries. This helper searches the target for such a
+/// dylib. Returns nullptr if no such dylib was found.
lldb::ModuleSP GetPreferredAsanModule(const Target &target);
} // namespace lldb_private
``````````
</details>
https://github.com/llvm/llvm-project/pull/132910
More information about the lldb-commits
mailing list