diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2021-12-20 10:58:37 +0300 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-20 11:07:10 +0300 |
| commit | 5c63c0a58ca34d12cf70bf0021cf851f4e6192d6 (patch) | |
| tree | f29bc4257f331e23729a6400a318f7aa9bca9ec8 /source/blender/makesdna/DNA_screen_types.h | |
| parent | 528fc35fedcdc7d6e8c3a6f32a7913342d3fb801 (diff) | |
Docs: use doxygen formatting for DNA
Differentiate doc-strings from title/section text.
Also use explicit doxygen references to struct members
so it's not ambiguous which member is being referenced.
Note that these changes aren't complete (some files weren't touched).
Diffstat (limited to 'source/blender/makesdna/DNA_screen_types.h')
| -rw-r--r-- | source/blender/makesdna/DNA_screen_types.h | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/source/blender/makesdna/DNA_screen_types.h b/source/blender/makesdna/DNA_screen_types.h index a4c254d6e5a..1a1d7cba7af 100644 --- a/source/blender/makesdna/DNA_screen_types.h +++ b/source/blender/makesdna/DNA_screen_types.h @@ -244,7 +244,7 @@ typedef struct PanelCategoryDyn { rcti rect; } PanelCategoryDyn; -/* region stack of active tabs */ +/** Region stack of active tabs. */ typedef struct PanelCategoryStack { struct PanelCategoryStack *next, *prev; char idname[64]; @@ -654,8 +654,10 @@ enum { #define UILST_FLT_SORT_MASK (((unsigned int)(UILST_FLT_SORT_REVERSE | UILST_FLT_SORT_LOCK)) - 1) -/* regiontype, first two are the default set */ -/* Do NOT change order, append on end. Types are hardcoded needed */ +/** + * regiontype, first two are the default set. + * \warning Do NOT change order, append on end. Types are hard-coded needed. + */ typedef enum eRegion_Type { RGN_TYPE_WINDOW = 0, RGN_TYPE_HEADER = 1, |