[Bf-blender-cvs] [c3a400b73fb] master: Cleanup: use single back-tick quoting in comments
Campbell Barton
noreply at git.blender.org
Tue Jul 20 14:59:11 CEST 2021
Commit: c3a400b73fbf46f1b8cfa1a5735e2a96254974b2
Author: Campbell Barton
Date: Tue Jul 20 22:52:31 2021 +1000
Branches: master
https://developer.blender.org/rBc3a400b73fbf46f1b8cfa1a5735e2a96254974b2
Cleanup: use single back-tick quoting in comments
While doxygen supports both, conform to our style guide.
Note that single back-tick's are already used in a majority of comments.
===================================================================
M extern/rangetree/intern/generic_alloc_impl.h
M source/blender/blenkernel/BKE_DerivedMesh.h
M source/blender/blenkernel/intern/image_save.c
M source/blender/blenkernel/intern/main_idmap.c
M source/blender/blenkernel/intern/mball_tessellate.c
M source/blender/blenkernel/intern/mesh_mapping.c
M source/blender/blenkernel/intern/pbvh_bmesh.c
M source/blender/blenkernel/intern/scene.c
M source/blender/blenlib/BLI_array.h
M source/blender/blenlib/BLI_color.hh
M source/blender/blenlib/BLI_compiler_typecheck.h
M source/blender/blenlib/BLI_ghash.h
M source/blender/blenlib/BLI_link_utils.h
M source/blender/blenlib/BLI_linklist_stack.h
M source/blender/blenlib/BLI_math.h
M source/blender/blenlib/intern/BLI_dynstr.c
M source/blender/blenlib/intern/BLI_ghash.c
M source/blender/blenlib/intern/BLI_ghash_utils.c
M source/blender/blenlib/intern/BLI_kdopbvh.c
M source/blender/blenlib/intern/BLI_memiter.c
M source/blender/blenlib/intern/BLI_mempool.c
M source/blender/blenlib/intern/array_store.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_geom_inline.c
M source/blender/blenlib/intern/math_vector_inline.c
M source/blender/blenlib/intern/memory_utils.c
M source/blender/blenlib/intern/polyfill_2d.c
M source/blender/blenlib/intern/smallhash.c
M source/blender/blenlib/intern/string.c
M source/blender/blenlib/intern/timecode.c
M source/blender/blenloader/intern/writefile.c
M source/blender/bmesh/bmesh.h
M source/blender/bmesh/intern/bmesh_opdefines.c
M source/blender/bmesh/intern/bmesh_polygon.c
M source/blender/bmesh/intern/bmesh_query.c
M source/blender/bmesh/intern/bmesh_structure.c
M source/blender/compositor/operations/COM_SunBeamsOperation.cc
M source/blender/editors/animation/anim_markers.c
M source/blender/editors/interface/interface_handlers.c
M source/blender/editors/interface/view2d.c
M source/blender/editors/sculpt_paint/paint_image_proj.c
M source/blender/editors/space_view3d/view3d_camera_control.c
M source/blender/editors/space_view3d/view3d_utils.c
M source/blender/editors/transform/transform_snap_object.c
M source/blender/makesdna/DNA_documentation.h
M source/blender/makesdna/intern/dna_genfile.c
M source/blender/makesrna/intern/rna_access.c
M source/blender/makesrna/intern/rna_wm.c
M source/blender/modifiers/intern/MOD_normal_edit.c
M source/blender/python/generic/py_capi_utils.c
M source/blender/python/gpu/gpu_py.c
M source/blender/python/gpu/gpu_py_api.c
M source/blender/python/gpu/gpu_py_batch.c
M source/blender/python/gpu/gpu_py_buffer.c
M source/blender/python/gpu/gpu_py_capabilities.c
M source/blender/python/gpu/gpu_py_element.c
M source/blender/python/gpu/gpu_py_framebuffer.c
M source/blender/python/gpu/gpu_py_matrix.c
M source/blender/python/gpu/gpu_py_offscreen.c
M source/blender/python/gpu/gpu_py_platform.c
M source/blender/python/gpu/gpu_py_select.c
M source/blender/python/gpu/gpu_py_shader.c
M source/blender/python/gpu/gpu_py_state.c
M source/blender/python/gpu/gpu_py_texture.c
M source/blender/python/gpu/gpu_py_types.c
M source/blender/python/gpu/gpu_py_uniformbuffer.c
M source/blender/python/gpu/gpu_py_vertex_buffer.c
M source/blender/python/gpu/gpu_py_vertex_format.c
M source/blender/python/intern/bpy_utils_units.c
M source/blender/python/mathutils/mathutils.c
M source/blender/python/mathutils/mathutils_Matrix.c
M source/blender/render/intern/bake.c
M source/blender/windowmanager/gizmo/intern/wm_gizmo_map.c
M source/blender/windowmanager/intern/wm_files.c
M source/blender/windowmanager/intern/wm_gesture_ops.c
===================================================================
diff --git a/extern/rangetree/intern/generic_alloc_impl.h b/extern/rangetree/intern/generic_alloc_impl.h
index 0f9f5184637..fd6e85a155a 100644
--- a/extern/rangetree/intern/generic_alloc_impl.h
+++ b/extern/rangetree/intern/generic_alloc_impl.h
@@ -32,7 +32,7 @@
* - #TPOOL_STRUCT: Name for pool struct name.
* - #TPOOL_CHUNK_SIZE: Chunk size (optional), use 64kb when not defined.
*
- * \note #TPOOL_ALLOC_TYPE must be at least ``sizeof(void *)``.
+ * \note #TPOOL_ALLOC_TYPE must be at least `sizeof(void *)`.
*
* Defines the API, uses #TPOOL_IMPL_PREFIX to prefix each function.
*
diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h
index 904b7bb8718..e3954e134da 100644
--- a/source/blender/blenkernel/BKE_DerivedMesh.h
+++ b/source/blender/blenkernel/BKE_DerivedMesh.h
@@ -158,7 +158,7 @@ struct DerivedMesh {
int (*getNumPolys)(DerivedMesh *dm);
/** Copy a single vert/edge/tessellated face from the derived mesh into
- * ``*r_{vert/edge/face}``. note that the current implementation
+ * `*r_{vert/edge/face}`. note that the current implementation
* of this function can be quite slow, iterating over all
* elements (editmesh)
*/
diff --git a/source/blender/blenkernel/intern/image_save.c b/source/blender/blenkernel/intern/image_save.c
index 9e3d5a162ae..360bad3e786 100644
--- a/source/blender/blenkernel/intern/image_save.c
+++ b/source/blender/blenkernel/intern/image_save.c
@@ -135,8 +135,8 @@ static void imbuf_save_post(ImBuf *ibuf, ImBuf *colormanaged_ibuf)
/**
* \return success.
- * \note ``ima->filepath`` and ``ibuf->name`` should end up the same.
- * \note for multiview the first ``ibuf`` is important to get the settings.
+ * \note `ima->filepath` and `ibuf->name` should end up the same.
+ * \note for multi-view the first `ibuf` is important to get the settings.
*/
static bool image_save_single(ReportList *reports,
Image *ima,
diff --git a/source/blender/blenkernel/intern/main_idmap.c b/source/blender/blenkernel/intern/main_idmap.c
index 1d362db4432..1421d456883 100644
--- a/source/blender/blenkernel/intern/main_idmap.c
+++ b/source/blender/blenkernel/intern/main_idmap.c
@@ -49,9 +49,9 @@
* \{ */
struct IDNameLib_Key {
- /** ``ID.name + 2``: without the ID type prefix, since each id type gets its own 'map' */
+ /** `ID.name + 2`: without the ID type prefix, since each id type gets its own 'map'. */
const char *name;
- /** ``ID.lib``: */
+ /** `ID.lib`: */
const Library *lib;
};
diff --git a/source/blender/blenkernel/intern/mball_tessellate.c b/source/blender/blenkernel/intern/mball_tessellate.c
index 760febaca91..9dd583b4c6b 100644
--- a/source/blender/blenkernel/intern/mball_tessellate.c
+++ b/source/blender/blenkernel/intern/mball_tessellate.c
@@ -305,7 +305,7 @@ static void build_bvh_spatial(PROCESS *process,
/**
* Computes density from given metaball at given position.
- * Metaball equation is: ``(1 - r^2 / R^2)^3 * s``
+ * Metaball equation is: `(1 - r^2 / R^2)^3 * s`
*
* r = distance from center
* R = metaball radius
diff --git a/source/blender/blenkernel/intern/mesh_mapping.c b/source/blender/blenkernel/intern/mesh_mapping.c
index ca6c60557a6..d28bb9c0744 100644
--- a/source/blender/blenkernel/intern/mesh_mapping.c
+++ b/source/blender/blenkernel/intern/mesh_mapping.c
@@ -539,8 +539,8 @@ void BKE_mesh_edge_poly_map_create(MeshElemMap **r_map,
* \param totfinal: The size of \a final_origindex
* \param final_origindex: The size of the final array.
*
- * \note ``totsource`` could be ``totpoly``,
- * ``totfinal`` could be ``tottessface`` and ``final_origindex`` its ORIGINDEX customdata.
+ * \note `totsource` could be `totpoly`,
+ * `totfinal` could be `tottessface` and `final_origindex` its ORIGINDEX custom-data.
* This would allow an MPoly to loop over its tessfaces.
*/
void BKE_mesh_origindex_map_create(MeshElemMap **r_map,
diff --git a/source/blender/blenkernel/intern/pbvh_bmesh.c b/source/blender/blenkernel/intern/pbvh_bmesh.c
index d3d7f02ecad..93cffcf7164 100644
--- a/source/blender/blenkernel/intern/pbvh_bmesh.c
+++ b/source/blender/blenkernel/intern/pbvh_bmesh.c
@@ -1168,12 +1168,12 @@ static void pbvh_bmesh_split_edge(EdgeQueueContext *eq_ctx,
}
/**
- * The 2 new faces created and assigned to ``f_new`` have their
+ * The 2 new faces created and assigned to `f_new` have their
* verts & edges shuffled around.
*
* - faces wind anticlockwise in this example.
- * - original edge is ``(v1, v2)``
- * - original face is ``(v1, v2, v3)``
+ * - original edge is `(v1, v2)`
+ * - original face is `(v1, v2, v3)`
*
* <pre>
* + v3(v_opp)
@@ -1189,8 +1189,8 @@ static void pbvh_bmesh_split_edge(EdgeQueueContext *eq_ctx,
* (first) (second)
* </pre>
*
- * - f_new (first): ``v_tri=(v1, v4, v3), e_tri=(e1, e5, e4)``
- * - f_new (second): ``v_tri=(v4, v2, v3), e_tri=(e2, e3, e5)``
+ * - f_new (first): `v_tri=(v1, v4, v3), e_tri=(e1, e5, e4)`
+ * - f_new (second): `v_tri=(v4, v2, v3), e_tri=(e2, e3, e5)`
*/
/* Create two new faces */
diff --git a/source/blender/blenkernel/intern/scene.c b/source/blender/blenkernel/intern/scene.c
index cc5a8536a5a..a3a0ce0060b 100644
--- a/source/blender/blenkernel/intern/scene.c
+++ b/source/blender/blenkernel/intern/scene.c
@@ -2105,7 +2105,7 @@ Object *BKE_scene_object_find_by_name(const Scene *scene, const char *name)
/**
* Sets the active scene, mainly used when running in background mode
- * (``--scene`` command line argument).
+ * (`--scene` command line argument).
* This is also called to set the scene directly, bypassing windowing code.
* Otherwise #WM_window_set_active_scene is used when changing scenes by the user.
*/
@@ -3242,9 +3242,9 @@ void BKE_scene_multiview_filepath_get(SceneRenderView *srv, const char *filepath
}
/**
- * When multiview is not used the filepath is as usual (e.g., ``Image.jpg``).
+ * When multiview is not used the filepath is as usual (e.g., `Image.jpg`).
* When multiview is on, even if only one view is enabled the view is incorporated
- * into the file name (e.g., ``Image_L.jpg``). That allows for the user to re-render
+ * into the file name (e.g., `Image_L.jpg`). That allows for the user to re-render
* individual views.
*/
void BKE_scene_multiview_view_filepath_get(const RenderData *rd,
diff --git a/source/blender/blenlib/BLI_array.h b/source/blender/blenlib/BLI_array.h
index e40a79dad21..6bf29a6168f 100644
--- a/source/blender/blenlib/BLI_array.h
+++ b/source/blender/blenlib/BLI_array.h
@@ -58,7 +58,7 @@ void _bli_array_grow_func(void **arr_p,
/** \name Public defines
* \{ */
-/** use ``sizeof(*(arr))`` to ensure the array exists and is an array */
+/** use `sizeof(*(arr))` to ensure the array exists and is an array */
#define BLI_array_declare(arr) \
int _##arr##_len = ((void)(sizeof(*(arr))), 0); \
void *_##arr##_static = NULL
diff --git a/source/blender/blenlib/BLI_color.hh b/source/blender/blenlib/BLI_color.hh
index 76dfcf0b57d..d93bd7f6f76 100644
--- a/source/blender/blenlib/BLI_color.hh
+++ b/source/blender/blenlib/BLI_color.hh
@@ -34,11 +34,11 @@ namespace blender {
* Usage:
*
* Convert a theme byte color to a linearrgb premultiplied.
- * ```
+ * \code{.cc}
* ColorTheme4b theme_color;
* ColorSceneLinear4f<eAlpha::Premultiplied> linearrgb_color =
* BLI_color_convert_to_scene_linear(theme_color).premultiply_alpha();
- * ```
+ * \endcode
*
* The API is structured to make most use of inlining. Most notable are space
* conversions done via `BLI_color_convert_to*` functions.
diff --git a/source/blender/blenlib/BLI_compiler_typecheck.h b/source/blender/blenlib/BLI_compiler_typecheck.h
index d9c2bfc1d58..18be2190c1b 100644
--- a/source/blender/blenlib/BLI_compiler_typecheck.h
+++ b/source/blender/blenlib/BLI_compiler_typecheck.h
@@ -86,7 +86,7 @@
/**
* CHECK_TYPE_ANY: handy macro, eg:
- * ``CHECK_TYPE_ANY(var, Foo *, Bar *, Baz *)``
+ * `CHECK_TYPE_ANY(var, Foo *, Bar *, Baz *)`
*
* excuse ridiculously long generated args.
* \code{.py}
diff --git a/source/blender/blenlib/BLI_ghash.h b/source/blender/blenlib/BLI_ghash.h
index e708b327bd4..a2c5c6349a5 100644
--- a/source/blender/blenlib/BLI_ghash.h
+++ b/source/blender/blenlib/BLI_ghash.h
@@ -77,7 +77,7 @@ enum {
/* -------------------------------------------------------------------- */
/** \name GHash API
*
- * Defined in ``BLI_ghash.c``
+ * Defined in `BLI_ghash.c`
* \{ */
GHash *BLI_ghash_new_ex(GHashHashFP hashfp,
@@ -333,11 +333,11 @@ double BLI_gset_calc_quality(GSet *gs);
/* -------------------------------------------------------------------- */
/** \name GHash/GSet Utils
*
- * Defined in ``BLI_ghash_utils.c``
+ * Defined in `BLI_ghash_utils.c`
* \{ */
/**
- * Callbacks for GHash (``BLI_ghashutil_``)
+ * Callbacks for GHash (`BLI_ghashutil_`)
*
* \note '_p' suffix denotes void pointer arg,
* so we can have functions that take correctly typed args too.
diff --git a/source/blender/blenlib/BLI_link_utils.h b/source/blender/blenlib/BLI_link_utils.h
index e1e4a8dbd4a..7aa7300da16 100644
--- a/source/blender/blenlib/BLI_link_utils.h
+++ b/source/blender/blenlib/BLI_link_utils.h
@@ -20,7 +20,7 @@
* \ingroup bli
* \brief Single link-list utility macros. (header only api).
*
- * Use this api when the structure defines its own ``next`` pointer
+ * Use this api when the structure defines its own `next` pointer
* and a double linked list such as #ListBase isn't needed.
*/
diff --git a/source/blender/blenlib/BLI_linklist_stack.h b/source/blender/blenlib/BLI_linklist_stack.h
index 8a5e94a7b56..d07bc40c923 100644
--- a/source/blender/blenlib/BLI_linklist_stack.h
+++ b/source/blender/blenlib/BLI_linklist_stack.h
@@ -28,7 +28,7 @@
* \note These macros follow STACK_* macros defined in 'BLI_utildefines.h'
* and should be kept (mostly) interchangeable.
*
- * \note ``_##var##_type`` is a dummy variable only used for typechecks.
+ * \note `_##var##_type` is a dummy variable only used for type-checks.
*/
/* -----------------------------
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list