diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-07-20 15:52:31 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-07-20 15:58:14 +0300 |
commit | c3a400b73fbf46f1b8cfa1a5735e2a96254974b2 (patch) | |
tree | 71d54f9f4cd25eed51a3ff20a96b29ece7979608 /source/blender/bmesh | |
parent | 48a45c43e4902e1dd431bf1472e7b1dfb2ec64e3 (diff) |
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.
Diffstat (limited to 'source/blender/bmesh')
-rw-r--r-- | source/blender/bmesh/bmesh.h | 22 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_opdefines.c | 2 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_polygon.c | 2 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_query.c | 6 | ||||
-rw-r--r-- | source/blender/bmesh/intern/bmesh_structure.c | 2 |
5 files changed, 17 insertions, 17 deletions
diff --git a/source/blender/bmesh/bmesh.h b/source/blender/bmesh/bmesh.h index a5241f6b36d..40db423ba2f 100644 --- a/source/blender/bmesh/bmesh.h +++ b/source/blender/bmesh/bmesh.h @@ -37,7 +37,7 @@ * * BMHeader flags should **never** be read or written to by bmesh operators (see Operators below). * - * Access to header flags is done with ``BM_elem_flag_*()`` functions. + * Access to header flags is done with `BM_elem_flag_*()` functions. * \subsection bm_faces Faces * * Faces in BMesh are stored as a circular linked list of loops. Loops store per-face-vertex data @@ -55,7 +55,7 @@ * * - BMLoop#v - pointer to the vertex associated with this loop. * - BMLoop#e - pointer to the edge associated with this loop, - * between verts ``(loop->v, loop->next->v)`` + * between verts `(loop->v, loop->next->v)` * - BMLoop#f - pointer to the face associated with this loop. * \subsection bm_two_side_face 2-Sided Faces * @@ -113,7 +113,7 @@ * * These slots are identified by name, using strings. * - * Access to slots is done with ``BMO_slot_***()`` functions. + * Access to slots is done with `BMO_slot_***()` functions. * \subsection bm_tool_flags Tool Flags * * The BMesh API provides a set of flags for faces, edges and vertices, @@ -126,7 +126,7 @@ * These flags should not be confused with header flags, which are used to store persistent flags * (e.g. selection, hide status, etc). * - * Access to tool flags is done with ``BMO_elem_flag_***()`` functions. + * Access to tool flags is done with `BMO_elem_flag_***()` functions. * * \warning Operators are **never** allowed to read or write to header flags. * They act entirely on the data inside their input slots. @@ -162,14 +162,14 @@ * * These conventions should be used throughout the bmesh module. * - * - ``bmesh_kernel_*()`` - Low level API, for primitive functions that others are built ontop of. - * - ``bmesh_***()`` - Low level API function. - * - ``bm_***()`` - 'static' functions, not a part of the API at all, + * - `bmesh_kernel_*()` - Low level API, for primitive functions that others are built ontop of. + * - `bmesh_***()` - Low level API function. + * - `bm_***()` - 'static' functions, not a part of the API at all, * but use prefix since they operate on BMesh data. - * - ``BM_***()`` - High level BMesh API function for use anywhere. - * - ``BMO_***()`` - High level operator API function for use anywhere. - * - ``bmo_***()`` - Low level / internal operator API functions. - * - ``_bm_***()`` - Functions which are called via macros only. + * - `BM_***()` - High level BMesh API function for use anywhere. + * - `BMO_***()` - High level operator API function for use anywhere. + * - `bmo_***()` - Low level / internal operator API functions. + * - `_bm_***()` - Functions which are called via macros only. * * \section bm_todo BMesh TODO's * diff --git a/source/blender/bmesh/intern/bmesh_opdefines.c b/source/blender/bmesh/intern/bmesh_opdefines.c index e106643a55f..b63a09a97a6 100644 --- a/source/blender/bmesh/intern/bmesh_opdefines.c +++ b/source/blender/bmesh/intern/bmesh_opdefines.c @@ -245,7 +245,7 @@ static BMOpDefine bmo_region_extend_def = { * Edge Rotate. * * Rotates edges topologically. Also known as "spin edge" to some people. - * Simple example: ``[/] becomes [|] then [\]``. + * Simple example: `[/] becomes [|] then [\]`. */ static BMOpDefine bmo_rotate_edges_def = { "rotate_edges", diff --git a/source/blender/bmesh/intern/bmesh_polygon.c b/source/blender/bmesh/intern/bmesh_polygon.c index 0aab10e7b1a..51ae47adacc 100644 --- a/source/blender/bmesh/intern/bmesh_polygon.c +++ b/source/blender/bmesh/intern/bmesh_polygon.c @@ -316,7 +316,7 @@ float BM_face_calc_perimeter_with_mat3(const BMFace *f, const float mat3[3][3]) /** * Utility function to calculate the edge which is most different from the other two. * - * \return The first edge index, where the second vertex is ``(index + 1) % 3``. + * \return The first edge index, where the second vertex is `(index + 1) % 3`. */ static int bm_vert_tri_find_unique_edge(BMVert *verts[3]) { diff --git a/source/blender/bmesh/intern/bmesh_query.c b/source/blender/bmesh/intern/bmesh_query.c index bc881040e4e..cb5764b1c91 100644 --- a/source/blender/bmesh/intern/bmesh_query.c +++ b/source/blender/bmesh/intern/bmesh_query.c @@ -766,7 +766,7 @@ bool BM_edge_loop_pair(BMEdge *e, BMLoop **r_la, BMLoop **r_lb) } /** - * Fast alternative to ``(BM_vert_edge_count(v) == 2)`` + * Fast alternative to `(BM_vert_edge_count(v) == 2)`. */ bool BM_vert_is_edge_pair(const BMVert *v) { @@ -779,7 +779,7 @@ bool BM_vert_is_edge_pair(const BMVert *v) } /** - * Fast alternative to ``(BM_vert_edge_count(v) == 2)`` + * Fast alternative to `(BM_vert_edge_count(v) == 2)` * that checks both edges connect to the same faces. */ bool BM_vert_is_edge_pair_manifold(const BMVert *v) @@ -896,7 +896,7 @@ int BM_vert_face_count_at_most(const BMVert *v, int count_max) /** * Return true if the vertex is connected to _any_ faces. * - * same as ``BM_vert_face_count(v) != 0`` or ``BM_vert_find_first_loop(v) == NULL`` + * same as `BM_vert_face_count(v) != 0` or `BM_vert_find_first_loop(v) == NULL`. */ bool BM_vert_face_check(const BMVert *v) { diff --git a/source/blender/bmesh/intern/bmesh_structure.c b/source/blender/bmesh/intern/bmesh_structure.c index cfdce0b749b..d5d72cd4ba3 100644 --- a/source/blender/bmesh/intern/bmesh_structure.c +++ b/source/blender/bmesh/intern/bmesh_structure.c @@ -592,7 +592,7 @@ int bmesh_radial_facevert_count_at_most(const BMLoop *l, const BMVert *v, const /** * \brief RADIAL CHECK FACE VERT * - * Quicker check for ``bmesh_radial_facevert_count(...) != 0`` + * Quicker check for `bmesh_radial_facevert_count(...) != 0`. */ bool bmesh_radial_facevert_check(const BMLoop *l, const BMVert *v) { |