Commit 3b142bc9 authored by Jonas Devlieghere's avatar Jonas Devlieghere
Browse files

[LLDB] Fix more -Wdocumentation issues (NFC)

parent de3fb1ec

lldb/include/lldb/Breakpoint/BreakpointOptions.h

+13 −14
Original line number Diff line number Diff line
@@ -295,9 +295,8 @@ public: 
  }



  /// Set the breakpoint to ignore the next \a count breakpoint hits.

  /// \param[in] count

  /// \param[in] n

  ///    The number of breakpoint hits to ignore.



  void SetIgnoreCount(uint32_t n) {

    m_ignore_count = n;

    m_set_flags.Set(eIgnoreCount);

lldb/include/lldb/Core/Address.h

+2 −2
Original line number Diff line number Diff line
@@ -131,7 +131,7 @@ public: 
  ///

  /// Initialize the address with the supplied \a section and \a offset.

  ///

  /// \param[in] section

  /// \param[in] section_sp

  ///     A section pointer to a valid lldb::Section, or NULL if the

  ///     address doesn't have a section or will get resolved later.

  ///
@@ -443,7 +443,7 @@ public: 


  /// Set accessor for the section.

  ///

  /// \param[in] section

  /// \param[in] section_sp

  ///     A new lldb::Section pointer to use as the section base. Can

  ///     be NULL for absolute addresses that are not relative to

  ///     any section.

lldb/include/lldb/Expression/ExpressionParser.h

+1 −1
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ public: 
  ///

  /// Initializes class variables.

  ///

  /// \param[in] exe_scope,

  /// \param[in] exe_scope

  ///     If non-NULL, an execution context scope that can help to

  ///     correctly create an expression with a valid process for

  ///     optional tuning Objective-C runtime support. Can be NULL.

lldb/include/lldb/Expression/UtilityFunction.h

+4 −4
Original line number Diff line number Diff line
@@ -60,16 +60,16 @@ public: 
  virtual bool Install(DiagnosticManager &diagnostic_manager,

                       ExecutionContext &exe_ctx) = 0;



  /// Check whether the given PC is inside the function

  /// Check whether the given address is inside the function

  ///

  /// Especially useful if the function dereferences nullptr to indicate a

  /// failed assert.

  ///

  /// \param[in] pc

  ///     The program counter to check.

  /// \param[in] address

  ///     The address to check.

  ///

  /// \return

  ///     True if the program counter falls within the function's bounds;

  ///     True if the address falls within the function's bounds;

  ///     false if not (or the function is not JIT compiled)

  bool ContainsAddress(lldb::addr_t address) {

    // nothing is both >= LLDB_INVALID_ADDRESS and < LLDB_INVALID_ADDRESS, so

lldb/include/lldb/Interpreter/CommandObject.h

+2 −2
Original line number Diff line number Diff line
@@ -261,8 +261,8 @@ public: 


  /// Get the command that appropriate for a "repeat" of the current command.

  ///

  /// \param[in] current_command_line

  ///    The complete current command line.

  /// \param[in] current_command_args

  ///    The command arguments.

  ///

  /// \return

  ///     nullptr if there is no special repeat command - it will use the