diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-10-27 13:32:09 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-10-27 13:45:55 +0300 |
commit | 4b188bb08cf5aaae3c68ab57bbcfa037eef1ac10 (patch) | |
tree | 25c77fc2deaa18ac62515838417aec6853b4c810 /source/blender/blenkernel | |
parent | 30f626fe4cd62f406468ef0ff2169694424b1a29 (diff) |
Cleanup: use over-line for doxy comments
Follow our code style for doxygen sections.
Diffstat (limited to 'source/blender/blenkernel')
-rw-r--r-- | source/blender/blenkernel/BKE_node.h | 3 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/editmesh_tangent.c | 1 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/icons.c | 2 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/idprop.c | 21 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/main_idmap.c | 1 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/mesh_remap.c | 1 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/mesh_runtime.c | 1 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/mesh_validate.c | 1 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/object_deform.c | 4 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/pbvh_bmesh.c | 1 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/workspace.c | 1 |
11 files changed, 20 insertions, 17 deletions
diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h index 38045e22def..128d7f86f21 100644 --- a/source/blender/blenkernel/BKE_node.h +++ b/source/blender/blenkernel/BKE_node.h @@ -880,8 +880,7 @@ void BKE_node_tree_unlink_id(ID *id, struct bNodeTree *ntree); * } FOREACH_NODETREE_END; * \endcode * - * \{ - */ + * \{ */ /* should be an opaque type, only for internal use by BKE_node_tree_iter_*** */ struct NodeTreeIterStore { diff --git a/source/blender/blenkernel/intern/editmesh_tangent.c b/source/blender/blenkernel/intern/editmesh_tangent.c index b3f6b543daf..9656c20f0be 100644 --- a/source/blender/blenkernel/intern/editmesh_tangent.c +++ b/source/blender/blenkernel/intern/editmesh_tangent.c @@ -35,6 +35,7 @@ /* interface */ #include "mikktspace.h" +/* -------------------------------------------------------------------- */ /** \name Tangent Space Calculation * \{ */ diff --git a/source/blender/blenkernel/intern/icons.c b/source/blender/blenkernel/intern/icons.c index bcec90cf0cf..eec9013d067 100644 --- a/source/blender/blenkernel/intern/icons.c +++ b/source/blender/blenkernel/intern/icons.c @@ -899,8 +899,10 @@ struct Icon_Geom *BKE_icon_geom_from_file(const char *filename) /** \} */ +/* -------------------------------------------------------------------- */ /** \name Studio Light Icon * \{ */ + int BKE_icon_ensure_studio_light(struct StudioLight *sl, int id_type) { int icon_id = get_next_free_id(); diff --git a/source/blender/blenkernel/intern/idprop.c b/source/blender/blenkernel/intern/idprop.c index 113d4cf50d7..13ceba8cc9f 100644 --- a/source/blender/blenkernel/intern/idprop.c +++ b/source/blender/blenkernel/intern/idprop.c @@ -68,9 +68,7 @@ static size_t idp_size_table[] = { }; /* -------------------------------------------------------------------- */ -/* Array Functions */ - -/** \name IDP Array API +/** \name Array Functions (IDP Array API) * \{ */ #define GETPROP(prop, i) &(IDP_IDPArray(prop)[i]) @@ -323,9 +321,7 @@ static IDProperty *IDP_CopyArray(const IDProperty *prop, const int flag) /** \} */ /* -------------------------------------------------------------------- */ -/* String Functions */ - -/** \name IDProperty String API +/** \name String Functions (IDProperty String API) * \{ */ /** @@ -439,9 +435,7 @@ void IDP_FreeString(IDProperty *prop) /** \} */ /* -------------------------------------------------------------------- */ -/* ID Type */ - -/** \name IDProperty ID API +/** \name ID Type (IDProperty ID API) * \{ */ static IDProperty *IDP_CopyID(const IDProperty *prop, const int flag) @@ -477,9 +471,7 @@ void IDP_AssignID(IDProperty *prop, ID *id, const int flag) /** \} */ /* -------------------------------------------------------------------- */ -/* Group Functions */ - -/** \name IDProperty Group API +/** \name Group Functions (IDProperty Group API) * \{ */ /** @@ -760,10 +752,9 @@ static void IDP_FreeGroup(IDProperty *prop, const bool do_id_user) /** \} */ /* -------------------------------------------------------------------- */ -/* Main Functions */ - -/** \name IDProperty Main API +/** \name Main Functions (IDProperty Main API) * \{ */ + IDProperty *IDP_CopyProperty_ex(const IDProperty *prop, const int flag) { switch (prop->type) { diff --git a/source/blender/blenkernel/intern/main_idmap.c b/source/blender/blenkernel/intern/main_idmap.c index 9a6ead7eb2b..21f5e9c6fb2 100644 --- a/source/blender/blenkernel/intern/main_idmap.c +++ b/source/blender/blenkernel/intern/main_idmap.c @@ -36,6 +36,7 @@ * Utility functions for faster ID lookups. */ +/* -------------------------------------------------------------------- */ /** \name BKE_main_idmap API * * Cache ID (name, library lookups). diff --git a/source/blender/blenkernel/intern/mesh_remap.c b/source/blender/blenkernel/intern/mesh_remap.c index 1c48cf6f3cb..f3b29171762 100644 --- a/source/blender/blenkernel/intern/mesh_remap.c +++ b/source/blender/blenkernel/intern/mesh_remap.c @@ -327,6 +327,7 @@ void BKE_mesh_remap_find_best_match_from_mesh(const MVert *verts_dst, /** \} */ +/* -------------------------------------------------------------------- */ /** \name Mesh to mesh mapping * \{ */ diff --git a/source/blender/blenkernel/intern/mesh_runtime.c b/source/blender/blenkernel/intern/mesh_runtime.c index 150f7f19edc..f35f4ae3501 100644 --- a/source/blender/blenkernel/intern/mesh_runtime.c +++ b/source/blender/blenkernel/intern/mesh_runtime.c @@ -267,6 +267,7 @@ void BKE_mesh_batch_cache_free(Mesh *me) /** \} */ +/* -------------------------------------------------------------------- */ /** \name Mesh runtime debug helpers. * \{ */ /* evaluated mesh info printing function, diff --git a/source/blender/blenkernel/intern/mesh_validate.c b/source/blender/blenkernel/intern/mesh_validate.c index 6fea2cc8bf5..b3c53df2d5f 100644 --- a/source/blender/blenkernel/intern/mesh_validate.c +++ b/source/blender/blenkernel/intern/mesh_validate.c @@ -52,6 +52,7 @@ static CLG_LogRef LOG = {"bke.mesh"}; +/* -------------------------------------------------------------------- */ /** \name Internal functions * \{ */ diff --git a/source/blender/blenkernel/intern/object_deform.c b/source/blender/blenkernel/intern/object_deform.c index 04f7529c6cd..1e7624d0d7d 100644 --- a/source/blender/blenkernel/intern/object_deform.c +++ b/source/blender/blenkernel/intern/object_deform.c @@ -51,6 +51,7 @@ #include "BKE_object.h" #include "BKE_object_deform.h" /* own include */ +/* -------------------------------------------------------------------- */ /** \name Misc helpers * \{ */ @@ -106,6 +107,7 @@ void BKE_object_defgroup_remap_update_users(Object *ob, const int *map) } /** \} */ +/* -------------------------------------------------------------------- */ /** \name Group creation * \{ */ @@ -156,6 +158,7 @@ MDeformVert *BKE_object_defgroup_data_create(ID *id) } /** \} */ +/* -------------------------------------------------------------------- */ /** \name Group clearing * \{ */ @@ -256,6 +259,7 @@ bool BKE_object_defgroup_clear_all(Object *ob, const bool use_selection) } /** \} */ +/* -------------------------------------------------------------------- */ /** \name Group removal * \{ */ diff --git a/source/blender/blenkernel/intern/pbvh_bmesh.c b/source/blender/blenkernel/intern/pbvh_bmesh.c index d31b0d54784..09e4ad93baa 100644 --- a/source/blender/blenkernel/intern/pbvh_bmesh.c +++ b/source/blender/blenkernel/intern/pbvh_bmesh.c @@ -63,6 +63,7 @@ static void pbvh_bmesh_verify(PBVH *pbvh); #endif +/* -------------------------------------------------------------------- */ /** \name BMesh Utility API * * Use some local functions which assume triangles. diff --git a/source/blender/blenkernel/intern/workspace.c b/source/blender/blenkernel/intern/workspace.c index cd163b7c8bf..43e03fb5165 100644 --- a/source/blender/blenkernel/intern/workspace.c +++ b/source/blender/blenkernel/intern/workspace.c @@ -98,6 +98,7 @@ IDTypeInfo IDType_ID_WS = { .blend_read_expand = NULL, }; +/* -------------------------------------------------------------------- */ /** \name Internal Utils * \{ */ |