Cleanup: use doxy sections following our style guide

This commit is contained in:
Campbell Barton
2024-11-25 13:20:09 +11:00
parent ecc17b400b
commit 8b29a50625

View File

@@ -6812,8 +6812,8 @@ PyTypeObject pyrna_struct_meta_idprop_Type = {
/*-----------------------BPy_StructRNA method def------------------------------*/
/**
* \defgroup BPY RNA Struct Type
/* -------------------------------------------------------------------- */
/** \name BPY RNA Struct Type
*
* These BPy_StructRNA objects should be created the standard way (calling their type objects
* using #PyObject_CallOneArg or similar). One and only one arg is expected currently.
@@ -6828,16 +6828,17 @@ PyTypeObject pyrna_struct_meta_idprop_Type = {
* \note: Subclassingfrom python isn't common since it's NOT related to registerable subclasses.
* eg:
*
* >>> class MyObSubclass(bpy.types.Object):
* ... def test_func(self):
* ... print(100)
* ...
* >>> myob = MyObSubclass(bpy.context.object)
* >>> myob.test_func()
* 100
* \code{.unparsed}
* >>> class MyObSubclass(bpy.types.Object):
* ... def test_func(self):
* ... print(100)
* ...
* >>> myob = MyObSubclass(bpy.context.object)
* >>> myob.test_func()
* 100
* \endcode
*
* @{
*/
* \{ */
static PyObject *pyrna_struct_new(PyTypeObject *type, PyObject *args, PyObject * /*kwds*/);
static int pyrna_struct_init(PyObject *self, PyObject *args, PyObject * /*kwds*/);
@@ -7054,12 +7055,12 @@ static void pyrna_struct_dealloc(PyObject *self)
PyErr_Restore(error_type, error_value, error_traceback);
}
/** @} */
/** \} */
/*-----------------------BPy_PropertyRNA method def------------------------------*/
/**
* \defgroup BPY RNA Property Types
/* -------------------------------------------------------------------- */
/** \name BPY RNA Property Types
*
* These BPy_PropertyRNA objects should be created the standard way (calling their type objects
* using #PyObject_CallOneArg or similar). One and only one arg is expected currently.
@@ -7075,8 +7076,7 @@ static void pyrna_struct_dealloc(PyObject *self)
*
* TODO Add python code example of using this overriding feature.
*
* @{
*/
* \{ */
static PyObject *pyrna_property_new(PyTypeObject *type, PyObject *args, PyObject * /*kwds*/);
static int pyrna_property_init(PyObject *self, PyObject *args, PyObject * /*kwds*/);
@@ -7710,15 +7710,13 @@ static PyObject *pyrna_prop_collection_iter_next(PyObject *self)
/* --- collection iterator: end --- */
#endif /* !USE_PYRNA_ITER */
/** @} */
/** \} */
/*-----------------------BPy_PropertyRNA method def------------------------------*/
/**
* \defgroup BPY RNA Function
*
* @{
*/
/* -------------------------------------------------------------------- */
/** \name BPY RNA Function
* \{ */
static PyObject *pyrna_function_new(PyTypeObject *type, PyObject *args, PyObject * /*kwds*/);
static int pyrna_function_init(PyObject *self, PyObject *args, PyObject * /*kwds*/);
@@ -7866,7 +7864,7 @@ static void pyrna_function_dealloc(PyObject *self)
PyErr_Restore(error_type, error_value, error_traceback);
}
/** @} */
/** \} */
static void pyrna_subtype_set_rna(PyObject *newclass, StructRNA *srna)
{