[all-commits] [llvm/llvm-project] e35fb3: [lldb] [NFC] Fix swig docstring annotations (#88073)

[Jason Molenda via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: e35fb3fb8bfcb732ace3738f9589989b3fac1508
      https://github.com/llvm/llvm-project/commit/e35fb3fb8bfcb732ace3738f9589989b3fac1508
  Author: Jason Molenda <jmolenda at apple.com>
  Date:   2024-04-08 (Mon, 08 Apr 2024)

  Changed paths:
    M lldb/bindings/interface/SBMemoryRegionInfoDocstrings.i
    M lldb/bindings/interface/SBProcessDocstrings.i
    M lldb/bindings/interface/SBQueueDocstrings.i
    M lldb/bindings/interface/SBThreadDocstrings.i

  Log Message:
  -----------
  [lldb] [NFC] Fix swig docstring annotations (#88073)

Some of the SB API method description docstrings for swing are annotated
as `%feature("autodoc")` - but `"autodoc"` annotations are only to
substitute a string showing the arguments and return variables - either
in a single line, or in multiple lines. SBMemoryRegionInfo used
`"autodoc"` correctly describing the parameters and return type, but
then it added a description too which is not correct either.

Change all of these that are adding a method description to use
`%feature("docstring")` instead. There were a half dozen instances where
`"autodoc"` was correctly being used and we have overriden the parameter
and return types with a more readable version.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications