forked from OSchip/llvm-project
3ebfeb2586
The current LLDB Python docs are missing documentation for all the special members such as conversion functions (`__int__`) and other special functions (`__len__`). The reason for that is that the `automodapi` plugin we're using to generate the *.rst files simply doesn't emit them. There doesn't seem to be any config option to enable those in `automodapi` and it's not even clear why they are filtered. I assume the leading underscore in their names makes them look like private methods. This patch just forcibly adds a few selected special members functions to the list of functions that sphinx should always document. This will cause sphinx to warn if a class doesn't have one of those functions but it's better than not having them documented. The main motivation here is that since `SBAddress.__int__` is one of the few functions that is only available in the embedded Python REPL which would be good to have in the public documentation. Fixes rdar://64647665 Reviewed By: JDevlieghere Differential Revision: https://reviews.llvm.org/D105480 |
||
---|---|---|
.. | ||
_lldb | ||
_static | ||
design | ||
man | ||
resources | ||
status | ||
testsuite | ||
use | ||
.htaccess | ||
CMakeLists.txt | ||
conf.py | ||
doxygen-mainpage.dox | ||
doxygen.cfg.in | ||
index.rst | ||
lldb-for-gdb-users.txt | ||
lldb-gdb-remote.txt | ||
lldb-platform-packets.txt | ||
python_api.rst | ||
python_api_enums.rst |