diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-02 09:24:04 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-02 14:53:44 +0300 |
commit | 42a6b2fd06e4fefe1bdb283d9e568d7f7dca178e (patch) | |
tree | 8006ad82c7b331eccb1433f8cda10d7372f44b3a /source/blender/python/bmesh/bmesh_py_types_customdata.h | |
parent | 17665494186816cebb9e8304199e40f9ee033990 (diff) |
Cleanup: move public doc-strings into headers for 'python'
Diffstat (limited to 'source/blender/python/bmesh/bmesh_py_types_customdata.h')
-rw-r--r-- | source/blender/python/bmesh/bmesh_py_types_customdata.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/source/blender/python/bmesh/bmesh_py_types_customdata.h b/source/blender/python/bmesh/bmesh_py_types_customdata.h index 8552942f73a..a5555a14ad7 100644 --- a/source/blender/python/bmesh/bmesh_py_types_customdata.h +++ b/source/blender/python/bmesh/bmesh_py_types_customdata.h @@ -23,7 +23,8 @@ #pragma once -/* all use BPy_BMLayerAccess struct */ +/* All use #BPy_BMLayerAccess struct. */ + extern PyTypeObject BPy_BMLayerAccessVert_Type; extern PyTypeObject BPy_BMLayerAccessEdge_Type; extern PyTypeObject BPy_BMLayerAccessFace_Type; @@ -36,14 +37,14 @@ extern PyTypeObject BPy_BMLayerItem_Type; #define BPy_BMLayerCollection_Check(v) (Py_TYPE(v) == &BPy_BMLayerCollection_Type) #define BPy_BMLayerItem_Check(v) (Py_TYPE(v) == &BPy_BMLayerItem_Type) -/* all layers for vert/edge/face/loop */ +/** All layers for vert/edge/face/loop. */ typedef struct BPy_BMLayerAccess { PyObject_VAR_HEAD struct BMesh *bm; /* keep first */ char htype; } BPy_BMLayerAccess; -/* access different layer types deform/uv/vertexcolor */ +/** Access different layer types deform/uv/vertex-color. */ typedef struct BPy_BMLayerCollection { PyObject_VAR_HEAD struct BMesh *bm; /* keep first */ @@ -51,7 +52,7 @@ typedef struct BPy_BMLayerCollection { int type; /* customdata type - CD_XXX */ } BPy_BMLayerCollection; -/* access a specific layer directly */ +/** Access a specific layer directly. */ typedef struct BPy_BMLayerItem { PyObject_VAR_HEAD struct BMesh *bm; /* keep first */ @@ -66,6 +67,10 @@ PyObject *BPy_BMLayerItem_CreatePyObject(BMesh *bm, const char htype, int type, void BPy_BM_init_types_customdata(void); -/* __getitem__ / __setitem__ */ +/** + *\brief BMElem.__getitem__() / __setitem__() + * + * Assume all error checks are done, eg: `uv = vert[uv_layer]` + */ PyObject *BPy_BMLayerItem_GetItem(BPy_BMElem *py_ele, BPy_BMLayerItem *py_layer); int BPy_BMLayerItem_SetItem(BPy_BMElem *py_ele, BPy_BMLayerItem *py_layer, PyObject *value); |