archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

API Docs: Correct syntax for bpy.utils.register_class

Browse Source
This commit is contained in:
Aaron Carlisle
2020-09-29 16:45:29 -04:00
parent db346ac2cd
commit f855dc8ce9
1 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
source/blender/python/intern/bpy_rna.c
View File

@@ -8700,16 +8700,21 @@ void pyrna_free_types(void)
PyDoc_STRVAR(pyrna_register_class_doc,
".. method:: register_class(cls)\n"
"\n"
" Register a subclass of a blender type in (:class:`bpy.types.Panel`,\n"
" :class:`bpy.types.UIList`, :class:`bpy.types.Menu`, :class:`bpy.types.Header`,\n"
" :class:`bpy.types.Operator`, :class:`bpy.types.KeyingSetInfo`,\n"
" :class:`bpy.types.RenderEngine`).\n"
"\n"
" If the class has a *register* class method it will be called\n"
" before registration.\n"
" Register a subclass of a Blender type class.\n"
"\n"
" :arg cls: Blender type class in:\n"
" :class:`bpy.types.Panel`, :class:`bpy.types.UIList`,\n"
" :class:`bpy.types.Menu`, :class:`bpy.types.Header`,\n"
" :class:`bpy.types.Operator`, :class:`bpy.types.KeyingSetInfo`,\n"
" :class:`bpy.types.RenderEngine`\n"
" :type cls: class\n"
" :raises ValueError:\n"
" if the class is not a subclass of a registerable blender class.\n");
" if the class is not a subclass of a registerable blender class.\n"
"\n"
" .. note::\n"
"\n"
" If the class has a *register* class method it will be called\n"
" before registration.\n");
PyMethodDef meth_bpy_register_class = {
"register_class", pyrna_register_class, METH_O, pyrna_register_class_doc};
static PyObject *pyrna_register_class(PyObject *UNUSED(self), PyObject *py_class)