diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-03-21 05:18:20 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-03-21 05:18:20 +0300 |
commit | 6db1fb197c169633bef9b23542464f89e9c4dbe6 (patch) | |
tree | 1b8706cb2e5962b02d0034cfc470a88018a386db /source/blender/makesdna | |
parent | b4e96550ce595a3f3c50a251033b41c2c117260a (diff) |
Cleanup: spelling, doxygen comment formatting
Diffstat (limited to 'source/blender/makesdna')
-rw-r--r-- | source/blender/makesdna/DNA_gpencil_modifier_types.h | 10 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_lineart_types.h | 6 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_node_types.h | 8 | ||||
-rw-r--r-- | source/blender/makesdna/DNA_userdef_types.h | 2 |
4 files changed, 15 insertions, 11 deletions
diff --git a/source/blender/makesdna/DNA_gpencil_modifier_types.h b/source/blender/makesdna/DNA_gpencil_modifier_types.h index 19555d93964..bc046a3b830 100644 --- a/source/blender/makesdna/DNA_gpencil_modifier_types.h +++ b/source/blender/makesdna/DNA_gpencil_modifier_types.h @@ -846,8 +846,10 @@ typedef struct LineartGpencilModifierData { struct Material *target_material; char target_layer[64]; - /** These two variables are to pass on vertex group information from mesh to strokes. - * vgname specifies which vertex groups our strokes from source_vertex_group will go to. */ + /** + * These two variables are to pass on vertex group information from mesh to strokes. + * `vgname` specifies which vertex groups our strokes from source_vertex_group will go to. + */ char source_vertex_group[64]; char vgname[64]; @@ -857,10 +859,10 @@ typedef struct LineartGpencilModifierData { unsigned char transparency_flags; /* eLineartGpencilTransparencyFlags */ unsigned char transparency_mask; - /** 0-1 range for cosine angle */ + /** `0..1` range for cosine angle */ float crease_threshold; - /** 0-PI angle, for splitting strokes at sharp points */ + /** `0..PI` angle, for splitting strokes at sharp points. */ float angle_splitting_threshold; /* CPU mode */ diff --git a/source/blender/makesdna/DNA_lineart_types.h b/source/blender/makesdna/DNA_lineart_types.h index 2eb36cfb9d3..31e221b74a0 100644 --- a/source/blender/makesdna/DNA_lineart_types.h +++ b/source/blender/makesdna/DNA_lineart_types.h @@ -57,12 +57,12 @@ typedef enum eLineartEdgeFlag { LRT_EDGE_FLAG_CREASE = (1 << 2), LRT_EDGE_FLAG_MATERIAL = (1 << 3), LRT_EDGE_FLAG_INTERSECTION = (1 << 4), - /** floating edge, unimplemented yet */ + /** Floating edge, unimplemented yet. */ LRT_EDGE_FLAG_FLOATING = (1 << 5), - /** also used as discarded line mark */ + /** Also used as discarded line mark. */ LRT_EDGE_FLAG_CHAIN_PICKED = (1 << 6), LRT_EDGE_FLAG_CLIPPED = (1 << 7), - /* Maxed out for 8 bits, DON'T ADD ANYMORE until improvements on the data structure. */ + /** Limited to 8 bits, DON'T ADD ANYMORE until improvements on the data structure. */ } eLineartEdgeFlag; #define LRT_EDGE_FLAG_ALL_TYPE 0x3f diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h index c61a39a20f0..f959f680895 100644 --- a/source/blender/makesdna/DNA_node_types.h +++ b/source/blender/makesdna/DNA_node_types.h @@ -1081,9 +1081,11 @@ typedef struct NodeCryptomatte_Runtime { } NodeCryptomatte_Runtime; typedef struct NodeCryptomatte { - /* iuser needs to be first element due to RNA limitations. - * When we define the ImageData properties, we can't define them from - * storage->iuser, so storage needs to be casted to ImageUser directly. */ + /** + * `iuser` needs to be first element due to RNA limitations. + * When we define the #ImageData properties, we can't define them from + * `storage->iuser`, so storage needs to be cast to #ImageUser directly. + */ ImageUser iuser; /* Contains `CryptomatteEntry`. */ diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index 7c92317b1b2..4595b12e9d4 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -281,7 +281,7 @@ typedef struct ThemeSpace { unsigned char edge_seam[4], edge_sharp[4], edge_facesel[4], edge_crease[4], edge_bevel[4]; /** Solid faces. */ unsigned char face[4], face_select[4], face_back[4], face_front[4]; - /** selected color. */ + /** Selected color. */ unsigned char face_dot[4]; unsigned char extra_edge_len[4], extra_edge_angle[4], extra_face_angle[4], extra_face_area[4]; unsigned char normal[4]; |