[Bf-blender-cvs] [4b188bb08cf] master: Cleanup: use over-line for doxy comments
Campbell Barton
noreply at git.blender.org
Tue Oct 27 11:47:05 CET 2020
Commit: 4b188bb08cf5aaae3c68ab57bbcfa037eef1ac10
Author: Campbell Barton
Date: Tue Oct 27 21:32:09 2020 +1100
Branches: master
https://developer.blender.org/rB4b188bb08cf5aaae3c68ab57bbcfa037eef1ac10
Cleanup: use over-line for doxy comments
Follow our code style for doxygen sections.
===================================================================
M intern/ghost/intern/GHOST_SystemWin32.cpp
M intern/ghost/intern/GHOST_SystemX11.cpp
M source/blender/blenkernel/BKE_node.h
M source/blender/blenkernel/intern/editmesh_tangent.c
M source/blender/blenkernel/intern/icons.c
M source/blender/blenkernel/intern/idprop.c
M source/blender/blenkernel/intern/main_idmap.c
M source/blender/blenkernel/intern/mesh_remap.c
M source/blender/blenkernel/intern/mesh_runtime.c
M source/blender/blenkernel/intern/mesh_validate.c
M source/blender/blenkernel/intern/object_deform.c
M source/blender/blenkernel/intern/pbvh_bmesh.c
M source/blender/blenkernel/intern/workspace.c
M source/blender/blenlib/BLI_ghash.h
M source/blender/blenlib/BLI_linklist_stack.h
M source/blender/blenlib/BLI_string.h
M source/blender/blenlib/BLI_string_utf8.h
M source/blender/blenlib/intern/BLI_heap.c
M source/blender/blenlib/intern/array_store.c
M source/blender/blenlib/intern/boxpack_2d.c
M source/blender/blenlib/intern/convexhull_2d.c
M source/blender/blenlib/intern/math_color_inline.c
M source/blender/blenlib/intern/math_geom.c
M source/blender/blenlib/intern/math_matrix.c
M source/blender/blenlib/intern/math_vector.c
M source/blender/blenlib/intern/math_vector_inline.c
M source/blender/blenlib/intern/rct.c
M source/blender/blenlib/intern/smallhash.c
M source/blender/bmesh/intern/bmesh_core.c
M source/blender/bmesh/intern/bmesh_delete.c
M source/blender/bmesh/intern/bmesh_interp.c
M source/blender/bmesh/intern/bmesh_marking.c
M source/blender/bmesh/intern/bmesh_mesh_duplicate.c
M source/blender/bmesh/intern/bmesh_polygon_edgenet.c
M source/blender/bmesh/intern/bmesh_walkers_impl.c
M source/blender/bmesh/operators/bmo_fill_grid.c
M source/blender/bmesh/tools/bmesh_path_region.c
M source/blender/bmesh/tools/bmesh_path_region_uv.c
M source/blender/bmesh/tools/bmesh_region_match.c
M source/blender/draw/engines/eevee/eevee_materials.c
M source/blender/draw/engines/eevee/eevee_shadows.c
M source/blender/draw/engines/eevee/eevee_volumes.c
M source/blender/draw/intern/draw_manager.c
M source/blender/draw/intern/draw_manager_shader.c
M source/blender/draw/intern/draw_view.c
M source/blender/editors/curve/editcurve_select.c
M source/blender/editors/curve/editfont_undo.c
M source/blender/editors/interface/interface.c
M source/blender/editors/interface/interface_utils.c
M source/blender/editors/mesh/editmesh_intersect.c
M source/blender/editors/mesh/editmesh_undo.c
M source/blender/editors/screen/workspace_edit.c
M source/blender/editors/sculpt_paint/sculpt.c
M source/blender/editors/transform/transform_mode.c
M source/blender/editors/transform/transform_mode_align.c
M source/blender/editors/transform/transform_mode_baketime.c
M source/blender/editors/transform/transform_mode_bbone_resize.c
M source/blender/editors/transform/transform_mode_bend.c
M source/blender/editors/transform/transform_mode_boneenvelope.c
M source/blender/editors/transform/transform_mode_boneroll.c
M source/blender/editors/transform/transform_mode_curveshrinkfatten.c
M source/blender/editors/transform/transform_mode_edge_bevelweight.c
M source/blender/editors/transform/transform_mode_edge_crease.c
M source/blender/editors/transform/transform_mode_edge_rotate_normal.c
M source/blender/editors/transform/transform_mode_edge_seq_slide.c
M source/blender/editors/transform/transform_mode_edge_slide.c
M source/blender/editors/transform/transform_mode_gpopacity.c
M source/blender/editors/transform/transform_mode_gpshrinkfatten.c
M source/blender/editors/transform/transform_mode_maskshrinkfatten.c
M source/blender/editors/transform/transform_mode_mirror.c
M source/blender/editors/transform/transform_mode_push_pull.c
M source/blender/editors/transform/transform_mode_resize.c
M source/blender/editors/transform/transform_mode_rotate.c
M source/blender/editors/transform/transform_mode_shear.c
M source/blender/editors/transform/transform_mode_shrink_fatten.c
M source/blender/editors/transform/transform_mode_skin_resize.c
M source/blender/editors/transform/transform_mode_tilt.c
M source/blender/editors/transform/transform_mode_timescale.c
M source/blender/editors/transform/transform_mode_timeslide.c
M source/blender/editors/transform/transform_mode_timetranslate.c
M source/blender/editors/transform/transform_mode_tosphere.c
M source/blender/editors/transform/transform_mode_trackball.c
M source/blender/editors/transform/transform_mode_translate.c
M source/blender/editors/transform/transform_mode_vert_slide.c
M source/blender/imbuf/intern/jp2.c
M source/blender/makesrna/intern/rna_wm_gizmo.c
M source/blender/windowmanager/gizmo/intern/wm_gizmo.c
M source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c
M source/blender/windowmanager/gizmo/intern/wm_gizmo_group_type.c
M source/blender/windowmanager/gizmo/intern/wm_gizmo_type.c
M source/blender/windowmanager/intern/wm_operator_type.c
===================================================================
diff --git a/intern/ghost/intern/GHOST_SystemWin32.cpp b/intern/ghost/intern/GHOST_SystemWin32.cpp
index b1e2502fa78..08df56d295b 100644
--- a/intern/ghost/intern/GHOST_SystemWin32.cpp
+++ b/intern/ghost/intern/GHOST_SystemWin32.cpp
@@ -1915,6 +1915,7 @@ void GHOST_SystemWin32::putClipboard(GHOST_TInt8 *buffer, bool selection) const
}
}
+/* -------------------------------------------------------------------- */
/** \name Message Box
* \{ */
GHOST_TSuccess GHOST_SystemWin32::showMessageBox(const char *title,
diff --git a/intern/ghost/intern/GHOST_SystemX11.cpp b/intern/ghost/intern/GHOST_SystemX11.cpp
index 1906ec67c33..8fd7ba13255 100644
--- a/intern/ghost/intern/GHOST_SystemX11.cpp
+++ b/intern/ghost/intern/GHOST_SystemX11.cpp
@@ -2284,6 +2284,7 @@ void GHOST_SystemX11::putClipboard(GHOST_TInt8 *buffer, bool selection) const
}
}
+/* -------------------------------------------------------------------- */
/** \name Message Box
* \{ */
class DialogData {
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
* \{ */
diff --git a/source/blender/blenlib/BLI_ghash.h b/source/blender/blenlib/BLI_ghash.h
index e38848e2967..bc517f81955 100644
--- a/source/blender/blenlib/BLI_ghash.h
+++ b/source/blender/blenlib/BLI_ghash.h
@@ -74,6 +74,7 @@ enum {
#endif
};
+/* -------------------------------------------------------------------- */
/** \name GHash API
*
* Defined in ``BLI_ghash.c``
@@ -124,6 +125,7 @@ void BLI_ghash_flag_clear(GHash *gh, unsigned int flag);
/** \} */
+/* -------------------------------------------------------------------- */
/** \name GHash Iterator
* \{ */
@@ -175,6 +177,7 @@ BLI_INLINE bool BLI_ghashIterator_done(GHashIterator *ghi)
/** \} */
+/* -------------------------------------------------------------------- */
/** \name GSet API
* A 'set' implementation (unordered collection of unique elements).
*
@@ -222,6 +225,7 @@ void *BLI_gset_pop_key(GSet *gs, const void *key) ATTR_WARN_UNUSED_RESULT;
/** \} */
+/* -------------------------------------------------------------------- */
/** \name GSet Iterator
* \{ */
@@ -272,6 +276,7 @@ BLI_INLINE bool BLI_gsetIterator_done(GSetIterator *gsi)
/** \} */
+/* -------------------------------------------------------------------- */
/** \name GHash/GSet Debugging API's
* \{ */
@@ -297,6 +302,7 @@ double BLI_gset_calc_quality(GSet *gs);
#endif /* GHASH_INTERNAL_API */
/** \} */
+/* -------------------------------------------------------------------- */
/** \name GHash/GSet Macros
* \{ */
@@ -324,6 +330,7 @@ double BLI_gset_calc_quality(GSet *gs);
/** \} */
+/* -------------------------------------------------------------------- */
/** \name GHash/GSet Utils
*
* Defined in ``BLI_ghash_utils.c``
diff --git a/source/blender/blenlib/BLI_linklist_stack.h b/source/blender/blenlib/BLI_linklist_stack.h
index 065ed12f353..be98304e6b5 100644
--- a/source/blender/blenlib/BLI_linklist_stack.h
+++ b/source/blender/blenlib/BLI_linklist_stack.h
@@ -32,12 +32,9 @@
*/
/* --
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list