From c3a400b73fbf46f1b8cfa1a5735e2a96254974b2 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 20 Jul 2021 22:52:31 +1000 Subject: 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. --- source/blender/blenkernel/BKE_DerivedMesh.h | 2 +- source/blender/blenkernel/intern/image_save.c | 4 ++-- source/blender/blenkernel/intern/main_idmap.c | 4 ++-- source/blender/blenkernel/intern/mball_tessellate.c | 2 +- source/blender/blenkernel/intern/mesh_mapping.c | 4 ++-- source/blender/blenkernel/intern/pbvh_bmesh.c | 10 +++++----- source/blender/blenkernel/intern/scene.c | 6 +++--- 7 files changed, 16 insertions(+), 16 deletions(-) (limited to 'source/blender/blenkernel') 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)` * * 
      *         + v3(v_opp)
@@ -1189,8 +1189,8 @@ static void pbvh_bmesh_split_edge(EdgeQueueContext *eq_ctx,
      *  (first) (second)
      *
* - * - 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, -- cgit v1.2.3