Skip to content

[lldb][docs][NFC] Fix some doxygen comments #132910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lldb/include/lldb/Core/Mangled.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};

Expand Down
4 changes: 2 additions & 2 deletions lldb/include/lldb/Core/Module.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};

Expand Down
12 changes: 6 additions & 6 deletions lldb/include/lldb/Interpreter/CommandInterpreter.h
Original file line number Diff line number Diff line change
Expand Up @@ -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 =
Expand Down
12 changes: 6 additions & 6 deletions lldb/include/lldb/Symbol/SymbolFile.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
6 changes: 3 additions & 3 deletions lldb/include/lldb/Target/Target.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};

Expand Down
5 changes: 3 additions & 2 deletions lldb/include/lldb/ValueObject/ValueObjectVariable.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)");
Expand Down
10 changes: 5 additions & 5 deletions lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down