Cleanup: move doc-strings into headers, remove duplicates

In some cases move implementation details into the function body.
This commit is contained in:
2023-03-29 14:16:31 +11:00
parent ce659dbc4e
commit 1ddbe7cadd
100 changed files with 339 additions and 348 deletions

View File

@@ -84,6 +84,7 @@
* `bpy.app.handler` callbacks for example.
* Even though this is arguably "correct", it's going to cause problems for existing scripts,
* so accept having this for the time being. */
BPy_StructRNA *bpy_context_module = NULL; /* for fast access */
static PyObject *pyrna_struct_Subtype(PointerRNA *ptr);
@@ -6515,10 +6516,6 @@ static PyObject *pyrna_func_doc_get(BPy_FunctionRNA *self, void *UNUSED(closure)
return ret;
}
/**
* Sub-classes of #pyrna_struct_Type which support idprop definitions use this as a meta-class.
* \note tp_base member is set to `&PyType_Type` on initialization.
*/
PyTypeObject pyrna_struct_meta_idprop_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
/*tp_name*/ "bpy_struct_meta_idprop",
@@ -6578,6 +6575,7 @@ PyTypeObject pyrna_struct_meta_idprop_Type = {
};
/*-----------------------BPy_StructRNA method def------------------------------*/
PyTypeObject pyrna_struct_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
/*tp_name*/ "bpy_struct",
@@ -6644,6 +6642,7 @@ PyTypeObject pyrna_struct_Type = {
};
/*-----------------------BPy_PropertyRNA method def------------------------------*/
PyTypeObject pyrna_prop_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
/*tp_name*/ "bpy_prop",
@@ -6870,6 +6869,7 @@ static PyTypeObject pyrna_prop_collection_idprop_Type = {
};
/*-----------------------BPy_PropertyRNA method def------------------------------*/
PyTypeObject pyrna_func_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
/*tp_name*/ "bpy_func",
@@ -7316,6 +7316,7 @@ static PyObject *pyrna_struct_Subtype(PointerRNA *ptr)
}
/*-----------------------CreatePyObject---------------------------------*/
PyObject *pyrna_struct_CreatePyObject(PointerRNA *ptr)
{
BPy_StructRNA *pyrna = NULL;
@@ -7837,6 +7838,7 @@ int pyrna_struct_as_ptr_or_null_parse(PyObject *o, void *p)
}
/* Orphan functions, not sure where they should go. */
StructRNA *srna_from_self(PyObject *self, const char *error_prefix)
{
@@ -8680,13 +8682,12 @@ static void bpy_class_free(void *pyob_ptr)
PyGILState_Release(gilstate);
}
/**
* \note This isn't essential to run on startup, since sub-types will lazy initialize.
* But keep running in debug mode so we get immediate notification of bad class hierarchy
* or any errors in "bpy_types.py" at load time, so errors don't go unnoticed.
*/
void pyrna_alloc_types(void)
{
/* NOTE: This isn't essential to run on startup, since sub-types will lazy initialize.
* But keep running in debug mode so we get immediate notification of bad class hierarchy
* or any errors in "bpy_types.py" at load time, so errors don't go unnoticed. */
#ifdef DEBUG
PyGILState_STATE gilstate;

View File

@@ -56,6 +56,10 @@ struct ID;
extern "C" {
#endif
/**
* Sub-classes of #pyrna_struct_Type which support idprop definitions use this as a meta-class.
* \note tp_base member is set to `&PyType_Type` on initialization.
*/
extern PyTypeObject pyrna_struct_meta_idprop_Type;
extern PyTypeObject pyrna_struct_Type;
extern PyTypeObject pyrna_prop_Type;