OSDN Git Service

[lldb][docs] Cleanup the Python doc strings for SB API classes
authorRaphael Isemann <teemperor@gmail.com>
Fri, 15 Jan 2021 18:49:51 +0000 (19:49 +0100)
committerRaphael Isemann <teemperor@gmail.com>
Sun, 17 Jan 2021 15:51:07 +0000 (16:51 +0100)
commitacdc74568927d47f94816e73b6e105c9460cc3e4
treeb3f76888fabb8e7807bb017a178c934a77ade2e2
parenta13c0f62c38131ef2656b06de02d82110abaf272
[lldb][docs] Cleanup the Python doc strings for SB API classes

The first line of the doc string ends up on the SB API class summary at
the root page of the Python API  web page of LLDB. Currently many of the
descriptions are missing or are several lines which makes the table really
hard to read.

This just adds the missing docstrings where possible and fixes the formatting
where necessary.
26 files changed:
lldb/bindings/interface/SBAttachInfo.i
lldb/bindings/interface/SBBreakpoint.i
lldb/bindings/interface/SBCommunication.i
lldb/bindings/interface/SBData.i
lldb/bindings/interface/SBExecutionContext.i
lldb/bindings/interface/SBFileSpecList.i
lldb/bindings/interface/SBFrame.i
lldb/bindings/interface/SBHostOS.i
lldb/bindings/interface/SBInstruction.i
lldb/bindings/interface/SBLanguageRuntime.i
lldb/bindings/interface/SBLaunchInfo.i
lldb/bindings/interface/SBLineEntry.i
lldb/bindings/interface/SBMemoryRegionInfoList.i
lldb/bindings/interface/SBModuleSpec.i
lldb/bindings/interface/SBPlatform.i
lldb/bindings/interface/SBQueue.i
lldb/bindings/interface/SBQueueItem.i
lldb/bindings/interface/SBReproducer.i
lldb/bindings/interface/SBStringList.i
lldb/bindings/interface/SBThreadPlan.i
lldb/bindings/interface/SBTrace.i
lldb/bindings/interface/SBTraceOptions.i
lldb/bindings/interface/SBType.i
lldb/bindings/interface/SBTypeEnumMember.i
lldb/bindings/interface/SBVariablesOptions.i
lldb/bindings/python/python-extensions.swig