Cleanup: doxygen comments

Also correct some outdated symbol references,
add missing 'name' commands.
This commit is contained in:
2019-11-25 01:14:39 +11:00
parent ace5677ef0
commit 249f4423ee
89 changed files with 549 additions and 299 deletions

View File

@@ -384,19 +384,21 @@ PyObject *BPy_BMLoopColor_CreatePyObject(struct MLoopCol *data)
* This is python type wraps a deform vert as a python dictionary,
* hiding the #MDeformWeight on access, since the mapping is very close, eg:
*
* C:
* weight = defvert_find_weight(dv, group_nr);
* defvert_remove_group(dv, dw)
* \code{.c}
* weight = defvert_find_weight(dv, group_nr);
* defvert_remove_group(dv, dw)
* \endcode
*
* Py:
* weight = dv[group_nr]
* del dv[group_nr]
* \code{.py}
* weight = dv[group_nr]
* del dv[group_nr]
* \endcode
*
* \note: there is nothing BMesh specific here,
* \note There is nothing BMesh specific here,
* its only that BMesh is the only part of blender that uses a hand written api like this.
* This type could eventually be used to access lattice weights.
*
* \note: Many of blender-api's dict-like-wrappers act like ordered dicts,
* \note Many of blender-api's dict-like-wrappers act like ordered dicts,
* This is intentionally _not_ ordered, the weights can be in any order and it won't matter,
* the order should not be used in the api in any meaningful way (as with a python dict)
* only expose as mapping, not a sequence.

View File

@@ -2596,7 +2596,8 @@ static PyObject *pyrna_prop_collection_subscript_slice(BPy_PropertyRNA *self,
return list;
}
/** TODO - dimensions
/**
* TODO - dimensions
* \note Could also use pyrna_prop_array_to_py_index(self, count) in a loop, but it's much slower
* since at the moment it reads (and even allocates) the entire array for each index.
*/