diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-06-27 07:34:16 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-06-27 08:43:20 +0300 |
commit | 4b96f4783197c6bbf34230385b711d685df2b545 (patch) | |
tree | bb49734d45a9d4e2e99e564ab49c431dcab99bfb /source/blender/blenlib/intern | |
parent | c1c5dff7c0a4950d53a45ea5d49b2f0dd6c1388b (diff) |
Docs: correct invalid doxygen params & references
Diffstat (limited to 'source/blender/blenlib/intern')
-rw-r--r-- | source/blender/blenlib/intern/delaunay_2d.c | 37 | ||||
-rw-r--r-- | source/blender/blenlib/intern/edgehash.c | 2 | ||||
-rw-r--r-- | source/blender/blenlib/intern/math_rotation.c | 4 | ||||
-rw-r--r-- | source/blender/blenlib/intern/storage.c | 2 |
4 files changed, 24 insertions, 21 deletions
diff --git a/source/blender/blenlib/intern/delaunay_2d.c b/source/blender/blenlib/intern/delaunay_2d.c index 4e0cd3a78dc..08ccff695c1 100644 --- a/source/blender/blenlib/intern/delaunay_2d.c +++ b/source/blender/blenlib/intern/delaunay_2d.c @@ -405,7 +405,8 @@ static CDTEdge *add_vert_to_symedge_edge(CDT_state *cdt, CDTVert *v, SymEdge *se return e; } -/* Connect the verts of se1 and se2, assuming that currently those two SymEdges are on +/** + * Connect the verts of se1 and se2, assuming that currently those two #SymEdges are on * the outer boundary (have face == outer_face) of two components that are isolated from * each other. */ @@ -479,7 +480,7 @@ static CDTEdge *split_edge(CDT_state *cdt, SymEdge *se, double lambda) * the deleted edge will be the one that was e's face. * There will be now an unused face, marked by setting its deleted flag, * and an unused #CDTEdge, marked by setting the next and rot pointers of - * its SymEdges to NULL. + * its #SymEdge(s) to NULL. * <pre> * . v2 . * / \ / \ @@ -1017,7 +1018,9 @@ static void initial_triangulation(CDT_state *cdt) MEM_freeN(sites); } -/** Use LinkNode linked list as stack of SymEdges, allocating from cdt->listpool. */ +/** + * Use #LinkNode linked list as stack of #SymEdges, allocating from `cdt->listpool` . + */ typedef LinkNode *Stack; BLI_INLINE void push(Stack *stack, SymEdge *se, CDT_state *cdt) @@ -1153,22 +1156,22 @@ static double tri_orient(const SymEdge *t) * in the path we will take to insert an edge constraint. * Each such point will either be * (a) a vertex or - * (b) a fraction lambda (0 < lambda < 1) along some SymEdge.] + * (b) a fraction lambda (0 < lambda < 1) along some #SymEdge.] * * In general, lambda=0 indicates case a and lambda != 0 indicates case be. * The 'in' edge gives the destination attachment point of a diagonal from the previous crossing, * and the 'out' edge gives the origin attachment point of a diagonal to the next crossing. * But in some cases, 'in' and 'out' are undefined or not needed, and will be NULL. * - * For case (a), 'vert' will be the vertex, and lambda will be 0, and 'in' will be the SymEdge from - * 'vert' that has as face the one that you go through to get to this vertex. If you go exactly - * along an edge then we set 'in' to NULL, since it won't be needed. The first crossing will have - * 'in' = NULL. We set 'out' to the SymEdge that has the face we go though to get to the next - * crossing, or, if the next crossing is a case (a), then it is the edge that goes to that next - * vertex. 'out' wlll be NULL for the last one. + * For case (a), 'vert' will be the vertex, and lambda will be 0, and 'in' will be the #SymEdge + * from 'vert' that has as face the one that you go through to get to this vertex. If you go + * exactly along an edge then we set 'in' to NULL, since it won't be needed. The first crossing + * will have 'in' = NULL. We set 'out' to the #SymEdge that has the face we go though to get to the + * next crossing, or, if the next crossing is a case (a), then it is the edge that goes to that + * next vertex. 'out' wlll be NULL for the last one. * * For case (b), vert will be NULL at first, and later filled in with the created split vertex, - * and 'in' will be the SymEdge that we go through, and lambda will be between 0 and 1, + * and 'in' will be the #SymEdge that we go through, and lambda will be between 0 and 1, * the fraction from in's vert to in->next's vert to put the split vertex. * 'out' is not needed in this case, since the attachment point will be the sym of the first * half of the split edge. @@ -1231,8 +1234,8 @@ static void fill_crossdata_for_through_vert(CDTVert *v, /** * As part of finding crossings, we found a case where orient tests say that the next crossing - * is on the SymEdge t, while intersecting with the ray from curco to v2. - * Find the intersection point and fill in the CrossData for that point. + * is on the #SymEdge t, while intersecting with the ray from \a curco to \a v2. + * Find the intersection point and fill in the #CrossData for that point. * It may turn out that when doing the intersection, we get an answer that says that * this case is better handled as through-vertex case instead, so we may do that. * In the latter case, we want to avoid a situation where the current crossing is on an edge @@ -1442,12 +1445,12 @@ static bool get_next_crossing_from_vert(CDT_state *cdt, } /** - * As part of finding the crossings of a ray to v2, find the next crossing after 'cd', assuming + * As part of finding the crossings of a ray to 'v2', find the next crossing after 'cd', assuming * 'cd' represents a crossing that goes through a an edge, not at either end of that edge. * - * We have the triangle vb-va-vc, where va and vb are the split edge and vc is the third vertex on - * that new side of the edge (should be closer to v2). The next crossing should be through vc or - * intersecting vb-vc or va-vc. + * We have the triangle 'vb-va-vc', where va and vb are the split edge and 'vc' is the third vertex + * on that new side of the edge (should be closer to v2). The next crossing should be through 'vc' + * or intersecting 'vb-vc' or 'va-vc'. */ static void get_next_crossing_from_edge(CDT_state *cdt, CrossData *cd, diff --git a/source/blender/blenlib/intern/edgehash.c b/source/blender/blenlib/intern/edgehash.c index 556c0a65fc5..56529581dd3 100644 --- a/source/blender/blenlib/intern/edgehash.c +++ b/source/blender/blenlib/intern/edgehash.c @@ -376,7 +376,7 @@ bool BLI_edgehash_ensure_p(EdgeHash *eh, uint v0, uint v1, void ***r_value) * Remove \a key (v0, v1) from \a eh, or return false if the key wasn't found. * * \param v0, v1: The key to remove. - * \param valfreefp: Optional callback to free the value. + * \param free_value: Optional callback to free the value. * \return true if \a key was removed from \a eh. */ bool BLI_edgehash_remove(EdgeHash *eh, uint v0, uint v1, EdgeHashFreeFP free_value) diff --git a/source/blender/blenlib/intern/math_rotation.c b/source/blender/blenlib/intern/math_rotation.c index a91cdabe3ab..7593f8a9bec 100644 --- a/source/blender/blenlib/intern/math_rotation.c +++ b/source/blender/blenlib/intern/math_rotation.c @@ -543,8 +543,8 @@ void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q * * \param q: input quaternion. * \param axis: twist axis in [0,1,2] - * \param r_swing[out]: if not NULL, receives the swing quaternion. - * \param r_twist[out]: if not NULL, receives the twist quaternion. + * \param r_swing: if not NULL, receives the swing quaternion. + * \param r_twist: if not NULL, receives the twist quaternion. * \returns twist angle. */ float quat_split_swing_and_twist(const float q[4], int axis, float r_swing[4], float r_twist[4]) diff --git a/source/blender/blenlib/intern/storage.c b/source/blender/blenlib/intern/storage.c index fbfb258693b..f2217b1cd1a 100644 --- a/source/blender/blenlib/intern/storage.c +++ b/source/blender/blenlib/intern/storage.c @@ -529,7 +529,7 @@ void *BLI_file_read_binary_as_mem(const char *filepath, size_t pad_bytes, size_t * Return the text file data with: * - Newlines replaced with '\0'. - * - Optionally trim whitespace, replacing trailing ' ' & '\t' with '\0'. + * - Optionally trim white-space, replacing trailing <space> & <tab> with '\0'. * * This is an alternative to using #BLI_file_read_as_lines, * allowing us to loop over lines without converting it into a linked list |