[Bf-blender-cvs] [521fab080bf] master: Cleanup: use doxygen links to struct members
Campbell Barton
noreply at git.blender.org
Tue Apr 5 00:03:10 CEST 2022
Commit: 521fab080bf8f7e3392b9f8d3d83a9067fc17914
Author: Campbell Barton
Date: Tue Apr 5 08:00:20 2022 +1000
Branches: master
https://developer.blender.org/rB521fab080bf8f7e3392b9f8d3d83a9067fc17914
Cleanup: use doxygen links to struct members
===================================================================
M source/blender/blenkernel/BKE_attribute.h
M source/blender/blenkernel/BKE_gpencil_update_cache.h
M source/blender/blenkernel/BKE_main.h
M source/blender/blenkernel/BKE_studiolight.h
M source/blender/blenlib/intern/scanfill.c
M source/blender/blenloader/intern/versioning_userdef.c
M source/blender/editors/include/ED_numinput.h
M source/blender/editors/include/UI_interface.h
M source/blender/editors/space_file/filelist.c
M source/blender/makesdna/DNA_ID.h
M source/blender/makesdna/DNA_brush_enums.h
M source/blender/makesdna/DNA_constraint_types.h
M source/blender/makesdna/DNA_curve_types.h
M source/blender/makesdna/DNA_curves_types.h
M source/blender/makesdna/DNA_customdata_types.h
M source/blender/makesdna/DNA_image_types.h
M source/blender/makesdna/DNA_scene_types.h
M source/blender/render/RE_engine.h
M source/blender/render/intern/render_types.h
M source/blender/sequencer/SEQ_add.h
===================================================================
diff --git a/source/blender/blenkernel/BKE_attribute.h b/source/blender/blenkernel/BKE_attribute.h
index 1987c925385..452d6a4316e 100644
--- a/source/blender/blenkernel/BKE_attribute.h
+++ b/source/blender/blenkernel/BKE_attribute.h
@@ -21,7 +21,7 @@ struct CustomDataLayer;
struct ID;
struct ReportList;
-/* Attribute.domain */
+/** #Attribute.domain */
typedef enum AttributeDomain {
ATTR_DOMAIN_AUTO = -1, /* Use for nodes to choose automatically based on other data. */
ATTR_DOMAIN_POINT = 0, /* Mesh, Curve or Point Cloud Point */
diff --git a/source/blender/blenkernel/BKE_gpencil_update_cache.h b/source/blender/blenkernel/BKE_gpencil_update_cache.h
index 52b8716bab5..f6ae7b53005 100644
--- a/source/blender/blenkernel/BKE_gpencil_update_cache.h
+++ b/source/blender/blenkernel/BKE_gpencil_update_cache.h
@@ -20,7 +20,7 @@ struct bGPDlayer;
struct bGPDstroke;
struct bGPdata;
-/* GPencilUpdateCache.flag */
+/** #GPencilUpdateCache.flag */
typedef enum eGPUpdateCacheNodeFlag {
/* Node is a placeholder (e.g. when only an index is needed). */
GP_UPDATE_NODE_NO_COPY = 0,
diff --git a/source/blender/blenkernel/BKE_main.h b/source/blender/blenkernel/BKE_main.h
index 2c64bb576b7..59b22f7759b 100644
--- a/source/blender/blenkernel/BKE_main.h
+++ b/source/blender/blenkernel/BKE_main.h
@@ -73,7 +73,7 @@ typedef struct MainIDRelationsEntry {
uint tags;
} MainIDRelationsEntry;
-/* MainIDRelationsEntry.tags */
+/** #MainIDRelationsEntry.tags */
typedef enum eMainIDRelationsEntryTags {
/* Generic tag marking the entry as to be processed. */
MAINIDRELATIONS_ENTRY_TAGS_DOIT = 1 << 0,
diff --git a/source/blender/blenkernel/BKE_studiolight.h b/source/blender/blenkernel/BKE_studiolight.h
index 68faa7613a9..1d1b6910b87 100644
--- a/source/blender/blenkernel/BKE_studiolight.h
+++ b/source/blender/blenkernel/BKE_studiolight.h
@@ -57,7 +57,7 @@ struct ImBuf;
struct GPUTexture;
struct StudioLight;
-/* StudioLight.flag */
+/** #StudioLight.flag */
enum StudioLightFlag {
STUDIOLIGHT_SPHERICAL_HARMONICS_COEFFICIENTS_CALCULATED = (1 << 0),
/* STUDIOLIGHT_LIGHT_DIRECTION_CALCULATED = (1 << 1), */
diff --git a/source/blender/blenlib/intern/scanfill.c b/source/blender/blenlib/intern/scanfill.c
index 32932c3dee1..bc07669687e 100644
--- a/source/blender/blenlib/intern/scanfill.c
+++ b/source/blender/blenlib/intern/scanfill.c
@@ -49,19 +49,19 @@ typedef struct ScanFillVertLink {
#define SF_EPSILON 0.00003f
#define SF_EPSILON_SQ (SF_EPSILON * SF_EPSILON)
-/* ScanFillVert.status */
+/** #ScanFillVert.status */
#define SF_VERT_NEW 0 /* all new verts have this flag set */
#define SF_VERT_AVAILABLE 1 /* available - in an edge */
#define SF_VERT_ZERO_LEN 2
-/* ScanFillEdge.status */
+/** #ScanFillEdge.status */
/* Optionally set ScanFillEdge f to this to mark original boundary edges.
* Only needed if there are internal diagonal edges passed to BLI_scanfill_calc. */
#define SF_EDGE_NEW 0 /* all new edges have this flag set */
// #define SF_EDGE_BOUNDARY 1 /* UNUSED */
#define SF_EDGE_INTERNAL 2 /* edge is created while scan-filling */
-/* PolyFill.status */
+/** #PolyFill.status */
#define SF_POLY_NEW 0 /* all polys initialized to this */
#define SF_POLY_VALID 1 /* has at least 3 verts */
diff --git a/source/blender/blenloader/intern/versioning_userdef.c b/source/blender/blenloader/intern/versioning_userdef.c
index dcf2ce4438d..ac5e3f97948 100644
--- a/source/blender/blenloader/intern/versioning_userdef.c
+++ b/source/blender/blenloader/intern/versioning_userdef.c
@@ -354,7 +354,7 @@ static void do_versions_theme(const UserDef *userdef, bTheme *btheme)
#undef USER_VERSION_ATLEAST
}
-/* UserDef.flag */
+/** #UserDef.flag */
#define USER_LMOUSESELECT (1 << 14) /* deprecated */
static void do_version_select_mouse(UserDef *userdef, wmKeyMapItem *kmi)
diff --git a/source/blender/editors/include/ED_numinput.h b/source/blender/editors/include/ED_numinput.h
index 12e3ffee627..a1b4e3a4552 100644
--- a/source/blender/editors/include/ED_numinput.h
+++ b/source/blender/editors/include/ED_numinput.h
@@ -43,7 +43,7 @@ typedef struct NumInput {
int str_cur;
} NumInput;
-/* NumInput.flag */
+/** #NumInput.flag */
enum {
NUM_AFFECT_ALL = (1 << 0),
/* (1 << 9) and above are reserved for internal flags! */
diff --git a/source/blender/editors/include/UI_interface.h b/source/blender/editors/include/UI_interface.h
index 0854b8b5cfa..4649fb06374 100644
--- a/source/blender/editors/include/UI_interface.h
+++ b/source/blender/editors/include/UI_interface.h
@@ -2948,7 +2948,7 @@ uiBlock *UI_region_block_find_mouse_over(const struct ARegion *region,
*/
struct ARegion *UI_region_searchbox_region_get(const struct ARegion *button_region);
-/* uiFontStyle.align */
+/** #uiFontStyle.align */
typedef enum eFontStyle_Align {
UI_STYLE_TEXT_LEFT = 0,
UI_STYLE_TEXT_CENTER = 1,
diff --git a/source/blender/editors/space_file/filelist.c b/source/blender/editors/space_file/filelist.c
index ceac53bde6b..08f4ecc0dd9 100644
--- a/source/blender/editors/space_file/filelist.c
+++ b/source/blender/editors/space_file/filelist.c
@@ -329,7 +329,7 @@ typedef struct FileListEntryCache {
int previews_todo_count;
} FileListEntryCache;
-/* FileListCache.flags */
+/** #FileListCache.flags */
enum {
FLC_IS_INIT = 1 << 0,
FLC_PREVIEWS_ACTIVE = 1 << 1,
@@ -359,7 +359,7 @@ typedef struct FileListFilter {
FileAssetCatalogFilterSettingsHandle *asset_catalog_filter;
} FileListFilter;
-/* FileListFilter.flags */
+/** #FileListFilter.flags */
enum {
FLF_DO_FILTER = 1 << 0,
FLF_HIDE_DOT = 1 << 1,
@@ -421,7 +421,7 @@ typedef struct FileList {
short tags; /* FileListTags */
} FileList;
-/* FileList.flags */
+/** #FileList.flags */
enum {
FL_FORCE_RESET = 1 << 0,
/* Don't do a full reset (unless #FL_FORCE_RESET is also set), only reset files representing main
@@ -434,7 +434,7 @@ enum {
FL_SORT_INVERT = 1 << 6,
};
-/* FileList.tags */
+/** #FileList.tags */
enum FileListTags {
/** The file list has references to main data (IDs) and needs special care. */
FILELIST_TAGS_USES_MAIN_DATA = (1 << 0),
diff --git a/source/blender/makesdna/DNA_ID.h b/source/blender/makesdna/DNA_ID.h
index 3ebf085443a..e3a6f50531d 100644
--- a/source/blender/makesdna/DNA_ID.h
+++ b/source/blender/makesdna/DNA_ID.h
@@ -335,7 +335,7 @@ enum {
/* 2 characters for ID code and 64 for actual name */
#define MAX_ID_NAME 66
-/* ID_Runtime_Remap.status */
+/** #ID_Runtime_Remap.status */
enum {
/** new_id is directly linked in current .blend. */
ID_REMAP_IS_LINKED_DIRECT = 1 << 0,
@@ -476,7 +476,7 @@ typedef struct Library {
short versionfile, subversionfile;
} Library;
-/* Library.tag */
+/** #Library.tag */
enum eLibrary_Tag {
/* Automatic recursive resync was needed when linking/loading data from that library. */
LIBRARY_TAG_RESYNC_REQUIRED = 1 << 0,
diff --git a/source/blender/makesdna/DNA_brush_enums.h b/source/blender/makesdna/DNA_brush_enums.h
index 783e79898ce..18d82448d1f 100644
--- a/source/blender/makesdna/DNA_brush_enums.h
+++ b/source/blender/makesdna/DNA_brush_enums.h
@@ -277,7 +277,7 @@ typedef enum eBrushSnakeHookDeformType {
BRUSH_SNAKE_HOOK_DEFORM_ELASTIC = 1,
} eBrushSnakeHookDeformType;
-/* Gpencilsettings.Vertex_mode */
+/** #Gpencilsettings.Vertex_mode */
typedef enum eGp_Vertex_Mode {
/* Affect to Stroke only. */
GPPAINT_MODE_STROKE = 0,
@@ -327,7 +327,7 @@ typedef enum ePaintBrush_flag {
BRUSH_PAINT_DENSITY_PRESSURE_INVERT = (1 << 9),
} ePaintBrush_flag;
-/* Brush.gradient_source */
+/** #Brush.gradient_source */
typedef enum eBrushGradientSourceStroke {
BRUSH_GRADIENT_PRESSURE = 0, /* gradient from pressure */
BRUSH_GRADIENT_SPACING_REPEAT = 1, /* gradient from spacing */
@@ -339,7 +339,7 @@ typedef enum eBrushGradientSourceFill {
BRUSH_GRADIENT_RADIAL = 1, /* gradient from spacing */
} eBrushGradientSourceFill;
-/* Brush.flag */
+/** #Brush.flag */
typedef enum eBrushFlags {
BRUSH_AIRBRUSH = (1 << 0),
BRUSH_INVERT_TO_SCRAPE_FILL = (1 << 1),
@@ -375,12 +375,12 @@ typedef enum eBrushFlags {
BRUSH_CURVE = (1u << 31),
} eBrushFlags;
-/* Brush.sampling_flag */
+/** #Brush.sampling_flag */
typedef enum eBrushSamplingFlags {
BRUSH_PAINT_ANTIALIASING = (1 << 0),
} eBrushSamplingFlags;
-/* Brush.flag2 */
+/** #Brush.flag2 */
typedef enum eBrushFlags2 {
BRUSH_MULTIPLANE_SCRAPE_DYNAMIC = (1 << 0),
BRUSH_MULTIPLANE_SCRAPE_PLANES_PREVIEW = (1 << 1),
@@ -398,7 +398,7 @@ typedef enum {
BRUSH_MASK_PRESSURE_CUTOFF = (1 << 2),
} BrushMaskPressureFlags;
-/* Brush.overlay_flags */
+/** #Brush.overlay_flags */
typedef enum eOverlayFlags {
BRUSH_OVERLAY_CURSOR = (1),
BRUSH_OVERLAY_PRIMARY = (1 << 1),
@@ -412,7 +412,7 @@ typedef enum eOverlayFlags {
(BRUSH_OVERLAY_CURSOR_OVERRIDE_ON_STROKE | BRUSH_OVERLAY_PRIMARY_OVERRIDE_ON_STROKE | \
BRUSH_OVERLAY_SECONDARY_OVERRIDE_ON_STROKE)
-/* Brush.sculpt_tool */
+/** #Brush.sculpt_tool */
typedef enum eBrushSculptTool {
SCULPT_TOOL_DRAW = 1,
SCULPT_TOOL_SMOOTH = 2,
@@ -448,7 +448,7 @@ typedef enum eBrushSculptTool {
SCULPT_TOOL_DISPLACEMENT_SMEAR = 32,
} eBrushSculptTool;
-/* Brush.uv_sculpt_tool */
+/** #Brush.uv_sculpt_tool */
typedef enum eBrushUVSculptTool {
UV_SCULPT_TOOL_GRAB = 0,
UV_SCULPT_TOOL_RELAX = 1,
@@ -602,7 +602,7 @@ typedef enum eBlurKernelType {
KERNEL_BOX = 1,
} eBlurKernelType;
-/* Brush.falloff_shape */
+/** #Brush.falloff_shape */
typedef enum eBrushFalloffShape {
PAINT_FALLOFF_SHAPE_SPHERE = 0,
PAINT_FALLOFF_SHAPE_TUBE = 1,
diff --git a/source/blender/makesdna/DNA_constraint_types.h b/source/blender/makesdna/DNA_constraint_types.h
index eaae82d0ccd..6557f35970d 100644
--- a/source/blender/makesdna/DNA_constraint_types.h
+++ b/source/blender/makesdna/DNA_constraint_types.h
@@ -745,7 +745,7 @@ typedef enum eConstraint_EulerOrder {
/* -------------------------------------- */
-/* bRotateLikeConstraint.flag */
+/** #bRotateLikeConstraint.flag */
typedef enum eCopyRotation_Flags {
ROTLIKE_X = (1 << 0),
ROTLIKE_Y = (1 << 1),
@@ -758,7 +758,7 @@ typedef enum eCopyRotation_Flags {
#endif
} eCopyRota
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list