Merge branch 'blender2.7'
[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 # Contributor(s): Campbell Barton
18 #
19 # ##### END GPL LICENSE BLOCK #####
20
21 # <pep8 compliant>
22
23 bpy_types_Operator_bl_property__doc__ = (
24     """
25 The name of a property to use as this operators primary property.
26 Currently this is only used to select the default property when
27 expanding an operator into a menu.
28 :type: string
29 """)
30
31
32 def main():
33     import bpy
34     from bpy.types import Operator
35
36     def dummy_func(test):
37         pass
38
39     kw_dummy = dict(fget=dummy_func, fset=dummy_func, fdel=dummy_func)
40
41     # bpy registration handles this,
42     # but its only checked for and not existing in the base class.
43     Operator.bl_property = property(doc=bpy_types_Operator_bl_property__doc__, **kw_dummy)
44
45
46 if __name__ == "__main__":
47     main()