https://github.com/Nerixyz created https://github.com/llvm/llvm-project/pull/181472
When building the HTML docs, the following warnings showed up that were fixed here: - "ERROR: Unexpected indentation" (7x) Sphinx expects a blank line after literal blocks. Fixed by adding the blank line. This is usually at the start of the paragraph, while the error may be reported on one of the next lines. - "WARNING: Block quote ends without a blank line; unexpected unindent" (11x) Similar to the other error, sphinx expects blank lines around most blocks. - "WARNING: 'any' reference target not found..." (37x) The doc comments are parsed as RST, where singe backticks are interpreted as references - unlike in Markdown. To get the same effect as in Markdown, two backticks have to be used. - "WARNING: more than one target found for 'any' cross-reference..." (7x) When referencing classes from the SB API, we have to be explicit. These warnings were all in the format "could be :doc:`SBSomething` or :py:class:`lldb.SBSomething`". Here, I used `:py:class:` as the role. >From ee24786ca98f8c6cfa0ad0280478b7d05cf25a25 Mon Sep 17 00:00:00 2001 From: Nerixyz <[email protected]> Date: Sat, 14 Feb 2026 11:50:17 +0100 Subject: [PATCH] [LLDB][Docs] Fix warnings when building HTML docs --- lldb/bindings/interface/SBFrameDocstrings.i | 2 +- .../interface/SBMemoryRegionInfoDocstrings.i | 6 ++--- .../python/templates/operating_system.py | 10 +++---- .../templates/scripted_frame_provider.py | 6 ++--- .../python/templates/scripted_platform.py | 2 +- .../python/templates/scripted_process.py | 20 +++++++------- .../python/templates/scripted_thread_plan.py | 18 ++++++------- lldb/include/lldb/API/SBAttachInfo.h | 2 +- lldb/include/lldb/API/SBCommandInterpreter.h | 8 +++--- lldb/include/lldb/API/SBEnvironment.h | 12 ++++++--- lldb/include/lldb/API/SBInstruction.h | 4 ++- lldb/include/lldb/API/SBLaunchInfo.h | 5 ++-- lldb/include/lldb/API/SBModule.h | 4 +-- lldb/include/lldb/API/SBProcess.h | 12 ++++----- lldb/include/lldb/API/SBStatisticsOptions.h | 26 +++++++++---------- lldb/include/lldb/API/SBTarget.h | 4 +-- lldb/include/lldb/API/SBTraceCursor.h | 19 +++++++------- lldb/include/lldb/API/SBValue.h | 4 +-- 18 files changed, 85 insertions(+), 79 deletions(-) diff --git a/lldb/bindings/interface/SBFrameDocstrings.i b/lldb/bindings/interface/SBFrameDocstrings.i index f6fb774111a16..2950ef5cb1550 100644 --- a/lldb/bindings/interface/SBFrameDocstrings.i +++ b/lldb/bindings/interface/SBFrameDocstrings.i @@ -83,7 +83,7 @@ See also SBThread." sets that exist for this thread. Each SBValue in the SBValueList represents one register-set. The first register-set will be the general purpose registers -- - the registers printed by the `register read` command-line in lldb, with + the registers printed by the ``register read`` command-line in lldb, with no additional arguments. The register-set SBValue will have a name, e.g. SBFrame::GetRegisters().GetValueAtIndex(0).GetName() diff --git a/lldb/bindings/interface/SBMemoryRegionInfoDocstrings.i b/lldb/bindings/interface/SBMemoryRegionInfoDocstrings.i index 99fe91b4558a4..94de8c7c05f2f 100644 --- a/lldb/bindings/interface/SBMemoryRegionInfoDocstrings.i +++ b/lldb/bindings/interface/SBMemoryRegionInfoDocstrings.i @@ -1,10 +1,8 @@ %feature("docstring", "API clients can get information about memory regions in processes. -For Python users, `len()` is overriden to output the size of the memory region in bytes. -For Python users, `str()` is overriden with the results of the GetDescription function- - produces a formatted string that describes a memory range in the form: - [Hex start - Hex End) with associated permissions (RWX)" +For Python users, ``len()`` is overriden to output the size of the memory region in bytes. +For Python users, ``str()`` is overriden with the results of the `GetDescription` function." ) lldb::SBMemoryRegionInfo; %feature("docstring", " diff --git a/lldb/examples/python/templates/operating_system.py b/lldb/examples/python/templates/operating_system.py index d83019079ee90..0723c932a716a 100644 --- a/lldb/examples/python/templates/operating_system.py +++ b/lldb/examples/python/templates/operating_system.py @@ -56,14 +56,14 @@ def create_thread(self, tid, context): """Lazily create an operating system thread using a thread information dictionary and an optional operating system thread context address. This method is called manually, using the SBAPI - `lldb.SBProcess.CreateOSPluginThread` affordance. + ``lldb.SBProcess.CreateOSPluginThread`` affordance. Args: - tid (int): Thread ID to get `thread_info` dictionary for. + tid (int): Thread ID to get ``thread_info`` dictionary for. context (int): Address of the operating system thread struct. Returns: - Dict: The `thread_info` dictionary containing the various information + Dict: The ``thread_info`` dictionary containing the various information for lldb to create a Thread object and add it to the process thread list. """ return None @@ -75,10 +75,10 @@ def get_thread_info(self): thread list. Returns: - List[thread_info]: A list of `os_thread` dictionaries + List[thread_info]: A list of ``os_thread`` dictionaries containing at least for each entry, the thread id, it's name, queue, state, stop reason. It can also contain a - `register_data_addr`. The list can be empty. + ``register_data_addr``. The list can be empty. """ pass diff --git a/lldb/examples/python/templates/scripted_frame_provider.py b/lldb/examples/python/templates/scripted_frame_provider.py index 1c982c517e7f4..94deb8604b7f6 100644 --- a/lldb/examples/python/templates/scripted_frame_provider.py +++ b/lldb/examples/python/templates/scripted_frame_provider.py @@ -16,7 +16,7 @@ class ScriptedFrameProvider(metaclass=ABCMeta): - Adding diagnostic or synthetic frames for debugging - Visualizing state machines or async execution contexts - Most of the base class methods are `@abstractmethod` that need to be + Most of the base class methods are ``@abstractmethod`` that need to be overwritten by the inheriting class. The constructor of this class sets up the following attributes: @@ -49,10 +49,10 @@ def __lldb_init_module(debugger, internal_dict): debugger.HandleCommand(f"target frame-provider register -C {__name__}.MyFrameProvider") if __name__ == '__main__': - print("This script should be loaded from LLDB using `command script import <filename>`") + print("This script should be loaded from LLDB using ``command script import <filename>``") You can register your frame provider either via the CLI command ``target frame-provider register`` or - via the API ``SBThread.RegisterScriptedFrameProvider``. + via the API ``lldb.SBThread.RegisterScriptedFrameProvider``. """ @staticmethod diff --git a/lldb/examples/python/templates/scripted_platform.py b/lldb/examples/python/templates/scripted_platform.py index 5805f99dea4ca..0b6bccd665e4c 100644 --- a/lldb/examples/python/templates/scripted_platform.py +++ b/lldb/examples/python/templates/scripted_platform.py @@ -8,7 +8,7 @@ class ScriptedPlatform(metaclass=ABCMeta): """ The base class for a scripted platform. - Most of the base class methods are `@abstractmethod` that need to be + Most of the base class methods are ``@abstractmethod`` that need to be overwritten by the inheriting class. """ diff --git a/lldb/examples/python/templates/scripted_process.py b/lldb/examples/python/templates/scripted_process.py index b6f2d18971e72..0a1697c017012 100644 --- a/lldb/examples/python/templates/scripted_process.py +++ b/lldb/examples/python/templates/scripted_process.py @@ -8,7 +8,7 @@ class ScriptedProcess(metaclass=ABCMeta): """ The base class for a scripted process. - Most of the base class methods are `@abstractmethod` that need to be + Most of the base class methods are ``@abstractmethod`` that need to be overwritten by the inheriting class. """ @@ -90,7 +90,7 @@ def read_memory_at_address(self, addr, size, error): error (lldb.SBError): Error object. Returns: - lldb.SBData: An `lldb.SBData` buffer with the target byte size and + lldb.SBData: An :py:class:`lldb.SBData` buffer with the target byte size and byte order storing the memory read. """ pass @@ -100,7 +100,7 @@ def write_memory_at_address(self, addr, data, error): Args: addr (int): Address from which we should start reading. - data (lldb.SBData): An `lldb.SBData` buffer to write to the process + data (lldb.SBData): An :py:class:`lldb.SBData` buffer to write to the process memory. error (lldb.SBError): Error object. @@ -124,7 +124,7 @@ def get_loaded_images(self): } Returns: - List[scripted_image]: A list of `scripted_image` dictionaries + List[scripted_image]: A list of ``scripted_image`` dictionaries containing for each entry the library UUID or its file path and its load address. None if the list is empty. @@ -143,7 +143,7 @@ def launch(self): """Simulate the scripted process launch. Returns: - lldb.SBError: An `lldb.SBError` with error code 0. + lldb.SBError: An :py:class:`lldb.SBError` with error code 0. """ return lldb.SBError() @@ -155,7 +155,7 @@ def attach(self, attach_info): process we're attaching to. Returns: - lldb.SBError: An `lldb.SBError` with error code 0. + lldb.SBError: An :py:class:`lldb.SBError` with error code 0. """ return lldb.SBError() @@ -167,7 +167,7 @@ def resume(self, should_stop=True): state to stopped after running it. Returns: - lldb.SBError: An `lldb.SBError` with error code 0. + lldb.SBError: An :py:class:`lldb.SBError` with error code 0. """ process = self.target.GetProcess() if not process: @@ -229,7 +229,7 @@ class ScriptedThread(metaclass=ABCMeta): """ The base class for a scripted thread. - Most of the base class methods are `@abstractmethod` that need to be + Most of the base class methods are ``@abstractmethod`` that need to be overwritten by the inheriting class. """ @@ -344,7 +344,7 @@ def get_stackframes(self): } Returns: - List[scripted_frame]: A list of `scripted_frame` dictionaries + List[scripted_frame]: A list of ``scripted_frame`` dictionaries containing at least for each entry, the frame index and the program counter value for that frame. The list can be empty. @@ -398,7 +398,7 @@ class ScriptedFrame(metaclass=ABCMeta): """ The base class for a scripted frame. - Most of the base class methods are `@abstractmethod` that need to be + Most of the base class methods are ``@abstractmethod`` that need to be overwritten by the inheriting class. """ diff --git a/lldb/examples/python/templates/scripted_thread_plan.py b/lldb/examples/python/templates/scripted_thread_plan.py index 67396cdfc53a2..be05785298791 100644 --- a/lldb/examples/python/templates/scripted_thread_plan.py +++ b/lldb/examples/python/templates/scripted_thread_plan.py @@ -13,7 +13,7 @@ def __init__(self, thread_plan: lldb.SBThreadPlan): """Initialization needs a valid lldb.SBThreadPlan object. This plug-in will get created after a live process is valid and has stopped. Args: - thread_plan (lldb.SBThreadPlan): The underlying `ThreadPlan` that is pushed onto the plan stack. + thread_plan (lldb.SBThreadPlan): The underlying ``ThreadPlan`` that is pushed onto the plan stack. """ self.thread_plan = thread_plan @@ -24,8 +24,8 @@ def explains_stop(self, event: lldb.SBEvent) -> bool: event (lldb.SBEvent): The process stop event. Returns: - bool: `True` if this stop could be claimed by this thread plan, `False` otherwise. - Defaults to `True`. + bool: ``True`` if this stop could be claimed by this thread plan, ``False`` otherwise. + Defaults to ``True``. """ return True @@ -33,8 +33,8 @@ def is_stale(self) -> bool: """If your plan is no longer relevant (for instance, you were stepping in a particular stack frame, but some other operation pushed that frame off the stack) return True and your plan will get popped. Returns: - bool: `True` if this thread plan is stale, `False` otherwise. - Defaults to `False`. + bool: ``True`` if this thread plan is stale, ``False`` otherwise. + Defaults to ``False``. """ return False @@ -46,8 +46,8 @@ def should_stop(self, event: lldb.SBEvent) -> bool: event (lldb.SBEvent): The process stop event. Returns: - bool: `True` if this plan wants to stop and return control to the user at this point, `False` otherwise. - Defaults to `False`. + bool: ``True`` if this plan wants to stop and return control to the user at this point, ``False`` otherwise. + Defaults to ``False``. """ self.thread_plan.SetPlanComplete(True) return True @@ -56,8 +56,8 @@ def should_step(self) -> bool: """Whether this thread plan should instruction step one instruction, or continue till the next breakpoint is hit. Returns: - bool: `True` if this plan will instruction step one instruction, `False` otherwise. - Defaults to `True`. + bool: ``True`` if this plan will instruction step one instruction, ``False`` otherwise. + Defaults to ``True``. """ return True diff --git a/lldb/include/lldb/API/SBAttachInfo.h b/lldb/include/lldb/API/SBAttachInfo.h index c18655fee77e0..17718f32cfc30 100644 --- a/lldb/include/lldb/API/SBAttachInfo.h +++ b/lldb/include/lldb/API/SBAttachInfo.h @@ -183,7 +183,7 @@ class LLDB_API SBAttachInfo { /// By default a process have no shadow event listener. /// Calling this function allows public process events to be broadcasted to an /// additional listener on top of the default process event listener. - /// If the `listener` argument is invalid (SBListener::IsValid() will + /// If the ``listener`` argument is invalid (SBListener::IsValid() will /// return false), this will clear the shadow listener. void SetShadowListener(SBListener &listener); diff --git a/lldb/include/lldb/API/SBCommandInterpreter.h b/lldb/include/lldb/API/SBCommandInterpreter.h index 752126c923946..5c5c0b413da27 100644 --- a/lldb/include/lldb/API/SBCommandInterpreter.h +++ b/lldb/include/lldb/API/SBCommandInterpreter.h @@ -316,8 +316,10 @@ class SBCommandInterpreter { SBStructuredData GetStatistics(); - /// Returns a list of handled commands, output and error. Each element in - /// the list is a dictionary with the following keys/values: + /// Returns a list of handled commands, output and error. + /// + /// Each element in the list is a dictionary with the following keys/values: + /// /// - "command" (string): The command that was given by the user. /// - "commandName" (string): The name of the executed command. /// - "commandArguments" (string): The arguments of the executed command. @@ -327,7 +329,7 @@ class SBCommandInterpreter { /// - "timestampInEpochSeconds" (int): The timestamp when the command is /// executed. /// - /// Turn on settings `interpreter.save-transcript` for LLDB to populate + /// Turn on settings ``interpreter.save-transcript`` for LLDB to populate /// this list. Otherwise this list is empty. SBStructuredData GetTranscript(); diff --git a/lldb/include/lldb/API/SBEnvironment.h b/lldb/include/lldb/API/SBEnvironment.h index f40ee01a42ab9..0dd36f9844528 100644 --- a/lldb/include/lldb/API/SBEnvironment.h +++ b/lldb/include/lldb/API/SBEnvironment.h @@ -60,16 +60,20 @@ class LLDB_API SBEnvironment { /// pointer to an empty string will be returned. const char *GetValueAtIndex(size_t index); - /// Return all environment variables contained in this object. Each variable - /// is returned as a string with the following format + /// Return all environment variables contained in this object. + /// + /// Each variable is returned as a string with the following format + /// /// name=value /// /// \return /// Return an lldb::SBStringList object with the environment variables. SBStringList GetEntries(); - /// Add or replace an existing environment variable. The input must be a - /// string with the format + /// Add or replace an existing environment variable. + /// + /// The input must be a string with the format + /// /// name=value /// /// \param [in] name_and_value diff --git a/lldb/include/lldb/API/SBInstruction.h b/lldb/include/lldb/API/SBInstruction.h index b899ac1203b68..e873db33167f6 100644 --- a/lldb/include/lldb/API/SBInstruction.h +++ b/lldb/include/lldb/API/SBInstruction.h @@ -74,7 +74,9 @@ class LLDB_API SBInstruction { bool TestEmulation(lldb::SBStream &output_stream, const char *test_file); /// Get variable annotations for this instruction as structured data. + /// /// Returns an array of dictionaries, each containing: + /// /// - "variable_name": string name of the variable /// - "location_description": string description of where variable is stored /// ("RDI", "R15", "undef", etc.) @@ -83,7 +85,7 @@ class LLDB_API SBInstruction { /// - "end_address": unsigned integer address where this annotation becomes /// invalid /// - "register_kind": unsigned integer indicating the register numbering - /// scheme + /// scheme /// - "decl_file": string path to the file where variable is declared /// - "decl_line": unsigned integer line number where variable is declared /// - "type_name": string type name of the variable diff --git a/lldb/include/lldb/API/SBLaunchInfo.h b/lldb/include/lldb/API/SBLaunchInfo.h index 06e72efc30f9f..e3818252c8304 100644 --- a/lldb/include/lldb/API/SBLaunchInfo.h +++ b/lldb/include/lldb/API/SBLaunchInfo.h @@ -107,7 +107,7 @@ class LLDB_API SBLaunchInfo { /// By default a process have no shadow event listener. /// Calling this function allows public process events to be broadcasted to an /// additional listener on top of the default process event listener. - /// If the `listener` argument is invalid (SBListener::IsValid() will + /// If the ``listener`` argument is invalid (SBListener::IsValid() will /// return false), this will clear the shadow listener. void SetShadowListener(SBListener &listener); @@ -129,8 +129,7 @@ class LLDB_API SBLaunchInfo { /// /// \param [in] envp /// The new environment variables as a list of strings with the following - /// format - /// name=value + /// format: ``name=value`` /// /// \param [in] append /// Flag that controls whether to replace the existing environment. diff --git a/lldb/include/lldb/API/SBModule.h b/lldb/include/lldb/API/SBModule.h index 4009ca1461e51..2d9bf5fa41e0c 100644 --- a/lldb/include/lldb/API/SBModule.h +++ b/lldb/include/lldb/API/SBModule.h @@ -265,8 +265,8 @@ class LLDB_API SBModule { /// this value is zero, then the return value will indicate /// how many version numbers there are in total so another call /// to this function can be make with adequate storage in - /// \a versions to get all of the version numbers. If \a - /// num_versions is less than the actual number of version + /// \a versions to get all of the version numbers. If + /// \a num_versions is less than the actual number of version /// numbers in this object file, only \a num_versions will be /// filled into \a versions (if \a versions is non-NULL). /// diff --git a/lldb/include/lldb/API/SBProcess.h b/lldb/include/lldb/API/SBProcess.h index 882b8bd837131..c52c7c3b0061c 100644 --- a/lldb/include/lldb/API/SBProcess.h +++ b/lldb/include/lldb/API/SBProcess.h @@ -364,25 +364,25 @@ class LLDB_API SBProcess { /// Save the state of the process in a core file. /// - /// \param[in] file_name - The name of the file to save the core file to. + /// \param[in] file_name The name of the file to save the core file to. /// - /// \param[in] flavor - Specify the flavor of a core file plug-in to save. - /// Currently supported flavors include "mach-o" and "minidump" + /// \param[in] flavor Specify the flavor of a core file plug-in to save. + /// Currently supported flavors include "mach-o" and "minidump" /// - /// \param[in] core_style - Specify the style of a core file to save. + /// \param[in] core_style Specify the style of a core file to save. lldb::SBError SaveCore(const char *file_name, const char *flavor, SaveCoreStyle core_style); /// Save the state of the process with the a flavor that matches the /// current process' main executable (if supported). /// - /// \param[in] file_name - The name of the file to save the core file to. + /// \param[in] file_name The name of the file to save the core file to. lldb::SBError SaveCore(const char *file_name); /// Save the state of the process with the desired settings /// as defined in the options object. /// - /// \param[in] options - The options to use when saving the core file. + /// \param[in] options The options to use when saving the core file. lldb::SBError SaveCore(SBSaveCoreOptions &options); /// Query the address load_addr and store the details of the memory diff --git a/lldb/include/lldb/API/SBStatisticsOptions.h b/lldb/include/lldb/API/SBStatisticsOptions.h index bfff9dc926432..8a26ccea68d82 100644 --- a/lldb/include/lldb/API/SBStatisticsOptions.h +++ b/lldb/include/lldb/API/SBStatisticsOptions.h @@ -23,8 +23,8 @@ class LLDB_API SBStatisticsOptions { const SBStatisticsOptions &operator=(const lldb::SBStatisticsOptions &rhs); /// If true, dump only high-level summary statistics. Exclude details like - /// targets, modules, breakpoints, etc. This turns off `IncludeTargets`, - /// `IncludeModules` and `IncludeTranscript` by default. + /// targets, modules, breakpoints, etc. This turns off ``IncludeTargets``, + /// ``IncludeModules`` and ``IncludeTranscript`` by default. /// /// Defaults to false. void SetSummaryOnly(bool b); @@ -33,11 +33,11 @@ class LLDB_API SBStatisticsOptions { /// If true, dump statistics for the targets, including breakpoints, /// expression evaluations, frame variables, etc. /// - /// Defaults to true, unless the `SummaryOnly` mode is enabled, in which case - /// this is turned off unless specified. + /// Defaults to true, unless the ``SummaryOnly`` mode is enabled, in which + /// case this is turned off unless specified. /// - /// If both `IncludeTargets` and `IncludeModules` are true, a list of module - /// identifiers will be added to the "targets" section. + /// If both ``IncludeTargets`` and ``IncludeModules`` are true, a list of + /// module identifiers will be added to the "targets" section. void SetIncludeTargets(bool b); bool GetIncludeTargets() const; @@ -45,17 +45,17 @@ class LLDB_API SBStatisticsOptions { /// various aspects of the module and debug information, type system, path, /// etc. /// - /// Defaults to true, unless the `SummaryOnly` mode is enabled, in which case - /// this is turned off unless specified. + /// Defaults to true, unless the ``SummaryOnly`` mode is enabled, in which + /// case this is turned off unless specified. /// - /// If both `IncludeTargets` and `IncludeModules` are true, a list of module - /// identifiers will be added to the "targets" section. + /// If both ``IncludeTargets` and ``IncludeModules`` are true, a list of + /// module identifiers will be added to the "targets" section. void SetIncludeModules(bool b); bool GetIncludeModules() const; - /// If true and the setting `interpreter.save-transcript` is enabled, include - /// a JSON array with all commands the user and/or scripts executed during a - /// debug session. + /// If true and the setting ``interpreter.save-transcript`` is enabled, + /// include a JSON array with all commands the user and/or scripts executed + /// during a debug session. /// /// Defaults to false. void SetIncludeTranscript(bool b); diff --git a/lldb/include/lldb/API/SBTarget.h b/lldb/include/lldb/API/SBTarget.h index dd2cf59b831da..59d0909c600fc 100644 --- a/lldb/include/lldb/API/SBTarget.h +++ b/lldb/include/lldb/API/SBTarget.h @@ -426,7 +426,7 @@ class LLDB_API SBTarget { /// The base address for the section. /// /// \return - /// An error to indicate success, fail, and any reason for + /// An error to indicate success, fail, and any reason for /// failure. lldb::SBError SetSectionLoadAddress(lldb::SBSection section, lldb::addr_t section_base_addr); @@ -438,7 +438,7 @@ class LLDB_API SBTarget { /// this target. /// /// \return - /// An error to indicate success, fail, and any reason for + /// An error to indicate success, fail, and any reason for /// failure. lldb::SBError ClearSectionLoadAddress(lldb::SBSection section); diff --git a/lldb/include/lldb/API/SBTraceCursor.h b/lldb/include/lldb/API/SBTraceCursor.h index 62bc3a91a855a..7db74bb6d396a 100644 --- a/lldb/include/lldb/API/SBTraceCursor.h +++ b/lldb/include/lldb/API/SBTraceCursor.h @@ -72,13 +72,14 @@ class LLDB_API SBTraceCursor { /// it. /// /// Requirements: + /// /// - For a given thread, no two instructions have the same id. /// - In terms of efficiency, moving the cursor to a given id should be as /// fast as possible, but not necessarily O(1). That's why the recommended - /// way to traverse sequential instructions is to use the \a - /// SBTraceCursor::Next() method and only use \a SBTraceCursor::GoToId(id) - /// sparingly. - + /// way to traverse sequential instructions is to use the + /// \a SBTraceCursor::Next() method and only use + /// \a SBTraceCursor::GoToId(id) sparingly. + /// /// Make the cursor point to the item whose identifier is \p id. /// /// \return @@ -88,8 +89,8 @@ class LLDB_API SBTraceCursor { bool GoToId(lldb::user_id_t id); /// \return - /// \b true if and only if there's an instruction item with the given \p - /// id. + /// \b true if and only if there's an instruction item with the given + /// \p id. bool HasId(lldb::user_id_t id) const; /// \return @@ -109,9 +110,9 @@ class LLDB_API SBTraceCursor { /// /// \param[in] offset /// How many items to move forwards (if positive) or backwards (if - /// negative) from the given origin point. For example, if origin is \b - /// End, then a negative offset would move backward in the trace, but a - /// positive offset would move past the trace to an invalid item. + /// negative) from the given origin point. For example, if origin is + /// \b End, then a negative offset would move backward in the trace, but + /// a positive offset would move past the trace to an invalid item. /// /// \param[in] origin /// The reference point to use when moving the cursor. diff --git a/lldb/include/lldb/API/SBValue.h b/lldb/include/lldb/API/SBValue.h index d4cc2f05c39e3..21566ce726605 100644 --- a/lldb/include/lldb/API/SBValue.h +++ b/lldb/include/lldb/API/SBValue.h @@ -273,8 +273,8 @@ class LLDB_API SBValue { /// doing any expensive type completion. /// /// \return - /// Returns \b true if the SBValue might have children, or \b - /// false otherwise. + /// Returns \b true if the SBValue might have children, or + /// \b false otherwise. bool MightHaveChildren(); bool IsRuntimeSupportValue(); _______________________________________________ lldb-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
