Skip to content

Commit 23bf98e

Browse files
authored
[lldb][docs][NFC] Fix some doxygen comments (#132910)
These weren't rendering properly (mostly mis-use the syntax for commenting member variables).
1 parent 8f863fc commit 23bf98e

File tree

8 files changed

+28
-31
lines changed

8 files changed

+28
-31
lines changed

lldb/include/lldb/Core/Mangled.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,11 +276,11 @@ class Mangled {
276276
void Encode(DataEncoder &encoder, ConstStringTable &strtab) const;
277277

278278
private:
279-
///< The mangled version of the name.
279+
/// The mangled version of the name.
280280
ConstString m_mangled;
281281

282-
///< Mutable so we can get it on demand with
283-
///< a const version of this object.
282+
/// Mutable so we can get it on demand with
283+
/// a const version of this object.
284284
mutable ConstString m_demangled;
285285
};
286286

lldb/include/lldb/Core/Module.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -951,8 +951,8 @@ class Module : public std::enable_shared_from_this<Module>,
951951
/// names we are looking for
952952
lldb::FunctionNameType m_name_type_mask = lldb::eFunctionNameTypeNone;
953953

954-
///< If \b true, then demangled names that match will need to contain
955-
///< "m_name" in order to be considered a match
954+
/// If \b true, then demangled names that match will need to contain
955+
/// "m_name" in order to be considered a match
956956
bool m_match_name_after_lookup = false;
957957
};
958958

lldb/include/lldb/Interpreter/CommandInterpreter.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -246,12 +246,12 @@ class CommandInterpreter : public Broadcaster,
246246
};
247247

248248
enum CommandTypes {
249-
eCommandTypesBuiltin = 0x0001, //< native commands such as "frame"
250-
eCommandTypesUserDef = 0x0002, //< scripted commands
251-
eCommandTypesUserMW = 0x0004, //< multiword commands (command containers)
252-
eCommandTypesAliases = 0x0008, //< aliases such as "po"
253-
eCommandTypesHidden = 0x0010, //< commands prefixed with an underscore
254-
eCommandTypesAllThem = 0xFFFF //< all commands
249+
eCommandTypesBuiltin = 0x0001, ///< native commands such as "frame"
250+
eCommandTypesUserDef = 0x0002, ///< scripted commands
251+
eCommandTypesUserMW = 0x0004, ///< multiword commands (command containers)
252+
eCommandTypesAliases = 0x0008, ///< aliases such as "po"
253+
eCommandTypesHidden = 0x0010, ///< commands prefixed with an underscore
254+
eCommandTypesAllThem = 0xFFFF ///< all commands
255255
};
256256

257257
using CommandReturnObjectCallback =

lldb/include/lldb/Symbol/SymbolFile.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -212,13 +212,13 @@ class SymbolFile : public PluginInterface {
212212
struct ArrayInfo {
213213
int64_t first_index = 0;
214214

215-
///< Each entry belongs to a distinct DW_TAG_subrange_type.
216-
///< For multi-dimensional DW_TAG_array_types we would have
217-
///< an entry for each dimension. An entry represents the
218-
///< optional element count of the subrange.
215+
/// Each entry belongs to a distinct DW_TAG_subrange_type.
216+
/// For multi-dimensional DW_TAG_array_types we would have
217+
/// an entry for each dimension. An entry represents the
218+
/// optional element count of the subrange.
219219
///
220-
///< The order of entries follows the order of the DW_TAG_subrange_type
221-
///< children of this DW_TAG_array_type.
220+
/// The order of entries follows the order of the DW_TAG_subrange_type
221+
/// children of this DW_TAG_array_type.
222222
llvm::SmallVector<std::optional<uint64_t>, 1> element_orders;
223223
uint32_t byte_stride = 0;
224224
uint32_t bit_stride = 0;

lldb/include/lldb/Target/Target.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -510,9 +510,9 @@ class EvaluateExpressionOptions {
510510
mutable std::string m_pound_line_file;
511511
mutable uint32_t m_pound_line_line = 0;
512512

513-
///< During expression evaluation, any SymbolContext in this list will be
514-
///< used for symbol/function lookup before any other context (except for
515-
///< the module corresponding to the current frame).
513+
/// During expression evaluation, any SymbolContext in this list will be
514+
/// used for symbol/function lookup before any other context (except for
515+
/// the module corresponding to the current frame).
516516
SymbolContextList m_preferred_lookup_contexts;
517517
};
518518

lldb/include/lldb/ValueObject/ValueObjectVariable.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,9 @@ class ValueObjectVariable : public ValueObject {
7575

7676
/// The variable that this value object is based upon.
7777
lldb::VariableSP m_variable_sp;
78-
///< The value that DWARFExpression resolves this variable to before we patch
79-
///< it up.
78+
79+
/// The value that DWARFExpression resolves this variable to before we patch
80+
/// it up.
8081
Value m_resolved_value;
8182

8283
private:

lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.cpp

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@
1313

1414
namespace lldb_private {
1515

16-
///< On Darwin, if LLDB loaded libclang_rt, it's coming from a locally built
17-
///< compiler-rt, and we should prefer it in favour of the system sanitizers.
18-
///< This helper searches the target for such a dylib. Returns nullptr if no
19-
///< such dylib was found.
2016
lldb::ModuleSP GetPreferredAsanModule(const Target &target) {
2117
lldb::ModuleSP module;
2218
llvm::Regex pattern(R"(libclang_rt\.asan_.*_dynamic\.dylib)");

lldb/source/Plugins/InstrumentationRuntime/Utility/Utility.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ namespace lldb_private {
1515

1616
class Target;
1717

18-
///< On Darwin, if LLDB loaded libclang_rt, it's coming from a locally built
19-
///< compiler-rt, and we should prefer it in favour of the system sanitizers
20-
///< when running InstrumentationRuntime utility expressions that use symbols
21-
///< from the sanitizer libraries. This helper searches the target for such a
22-
///< dylib. Returns nullptr if no such dylib was found.
18+
/// On Darwin, if LLDB loaded libclang_rt, it's coming from a locally built
19+
/// compiler-rt, and we should prefer it in favour of the system sanitizers
20+
/// when running InstrumentationRuntime utility expressions that use symbols
21+
/// from the sanitizer libraries. This helper searches the target for such a
22+
/// dylib. Returns nullptr if no such dylib was found.
2323
lldb::ModuleSP GetPreferredAsanModule(const Target &target);
2424

2525
} // namespace lldb_private

0 commit comments

Comments
 (0)