aboutsummaryrefslogtreecommitdiff
path: root/llvm/lib/Transforms/Utils/ScalarEvolutionExpander.cpp
diff options
context:
space:
mode:
authorRaphael Isemann <teemperor@gmail.com>2021-07-07 19:28:47 +0200
committerRaphael Isemann <teemperor@gmail.com>2021-07-07 19:49:50 +0200
commit3ebfeb258698db82b7525cfaa1efd04db93d72ba (patch)
tree3674bc729e399a4269d2bae6021193b24d3af7e4 /llvm/lib/Transforms/Utils/ScalarEvolutionExpander.cpp
parentd2e32fa493a272c21dee2c6cbf52e501f9ee3908 (diff)
downloadllvm-3ebfeb258698db82b7525cfaa1efd04db93d72ba.zip
llvm-3ebfeb258698db82b7525cfaa1efd04db93d72ba.tar.gz
llvm-3ebfeb258698db82b7525cfaa1efd04db93d72ba.tar.bz2
[lldb][docs] Force documentation emission of special Python class members
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
Diffstat (limited to 'llvm/lib/Transforms/Utils/ScalarEvolutionExpander.cpp')
0 files changed, 0 insertions, 0 deletions