[Lldb-commits] [lldb] 5d2f90c - [lldb] Correct some uses of \b in Doxygen documentation

[David Spickett via lldb-commits]

Author: David Spickett
Date: 2022-01-26T14:05:58Z
New Revision: 5d2f90cbcd5f64d3b47ba5d2738939be66f05936

URL: https://github.com/llvm/llvm-project/commit/5d2f90cbcd5f64d3b47ba5d2738939be66f05936
DIFF: https://github.com/llvm/llvm-project/commit/5d2f90cbcd5f64d3b47ba5d2738939be66f05936.diff

LOG: [lldb] Correct some uses of \b in Doxygen documentation

Added: 
    

Modified: 
    lldb/include/lldb/Breakpoint/BreakpointOptions.h
    lldb/include/lldb/Interpreter/Options.h
    lldb/include/lldb/Symbol/CompileUnit.h
    lldb/include/lldb/Target/Process.h
    lldb/include/lldb/Target/Target.h

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/Breakpoint/BreakpointOptions.h b/lldb/include/lldb/Breakpoint/BreakpointOptions.h
index ec39c976f7ac0..c2456024d9194 100644
--- a/lldb/include/lldb/Breakpoint/BreakpointOptions.h
+++ b/lldb/include/lldb/Breakpoint/BreakpointOptions.h
@@ -194,8 +194,8 @@ friend class Breakpoint;
   ///    The commands will be appended to this list.
   ///
   /// \return
-  ///    \btrue if the command callback is a command-line callback,
-  ///    \bfalse otherwise.
+  ///    \b true if the command callback is a command-line callback,
+  ///    \b false otherwise.
   bool GetCommandLineCallbacks(StringList &command_list);
 
   /// Remove the callback from this option set.

diff  --git a/lldb/include/lldb/Interpreter/Options.h b/lldb/include/lldb/Interpreter/Options.h
index 6bf5c21fe98e7..5899a9edc47f9 100644
--- a/lldb/include/lldb/Interpreter/Options.h
+++ b/lldb/include/lldb/Interpreter/Options.h
@@ -169,7 +169,7 @@ class Options {
   /// user wants returned.
   ///
   /// \return
-  ///     \btrue if we were in an option, \bfalse otherwise.
+  ///     \b true if we were in an option, \b false otherwise.
   bool HandleOptionCompletion(lldb_private::CompletionRequest &request,
                               OptionElementVector &option_map,
                               CommandInterpreter &interpreter);

diff  --git a/lldb/include/lldb/Symbol/CompileUnit.h b/lldb/include/lldb/Symbol/CompileUnit.h
index 34e34e5514df3..44e1d673f1fd1 100644
--- a/lldb/include/lldb/Symbol/CompileUnit.h
+++ b/lldb/include/lldb/Symbol/CompileUnit.h
@@ -208,9 +208,9 @@ class CompileUnit : public std::enable_shared_from_this<CompileUnit>,
   ///     unit file.
   ///
   /// \param[in] exact
-  ///     If \btrue match only if there is a line table entry for this line
+  ///     If \b true match only if there is a line table entry for this line
   ///     number.
-  ///     If \bfalse, find the line table entry equal to or after this line
+  ///     If \b false, find the line table entry equal to or after this line
   ///     number.
   ///
   /// \param[out] line_entry

diff  --git a/lldb/include/lldb/Target/Process.h b/lldb/include/lldb/Target/Process.h
index 255a8b4baaca6..12ed1e09227cf 100644
--- a/lldb/include/lldb/Target/Process.h
+++ b/lldb/include/lldb/Target/Process.h
@@ -1884,7 +1884,7 @@ class Process : public std::enable_shared_from_this<Process>,
   ///     want to deallocate.
   ///
   /// \return
-  ///     \btrue if the memory was deallocated, \bfalse otherwise.
+  ///     \b true if the memory was deallocated, \b false otherwise.
   virtual Status DoDeallocateMemory(lldb::addr_t ptr) {
     Status error;
     error.SetErrorStringWithFormatv(
@@ -1903,7 +1903,7 @@ class Process : public std::enable_shared_from_this<Process>,
   ///     want to deallocate.
   ///
   /// \return
-  ///     \btrue if the memory was deallocated, \bfalse otherwise.
+  ///     \b true if the memory was deallocated, \b false otherwise.
   Status DeallocateMemory(lldb::addr_t ptr);
 
   /// Get any available STDOUT.

diff  --git a/lldb/include/lldb/Target/Target.h b/lldb/include/lldb/Target/Target.h
index b85839c15b2f9..2c8b36d1e3d9c 100644
--- a/lldb/include/lldb/Target/Target.h
+++ b/lldb/include/lldb/Target/Target.h
@@ -991,7 +991,7 @@ class Target : public std::enable_shared_from_this<Target>,
   ///     manually set following this function call).
   ///
   /// \return
-  ///     \b true if the architecture was successfully set, \bfalse otherwise.
+  ///     \b true if the architecture was successfully set, \b false otherwise.
   bool SetArchitecture(const ArchSpec &arch_spec, bool set_platform = false);
 
   bool MergeArchitecture(const ArchSpec &arch_spec);