Fix (unreported) broken Py API doc after adding gpencil to buttons_context...
[blender.git] / doc / python_api / sphinx_doc_gen_monkeypatch.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 bpy_types_Operator_bl_property__doc__ = (
22     """
23 The name of a property to use as this operators primary property.
24 Currently this is only used to select the default property when
25 expanding an operator into a menu.
26 :type: string
27 """)
28
29
30 def main():
31     import bpy
32     from bpy.types import Operator
33
34     def dummy_func(test):
35         pass
36
37     kw_dummy = dict(fget=dummy_func, fset=dummy_func, fdel=dummy_func)
38
39     # bpy registration handles this,
40     # but its only checked for and not existing in the base class.
41     Operator.bl_property = property(doc=bpy_types_Operator_bl_property__doc__, **kw_dummy)
42
43
44 if __name__ == "__main__":
45     main()