From eff8cc9cccdaa7248d9d869473704e9db69c2f41 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sun, 14 Apr 2019 10:48:42 +0200 Subject: Cleanup: doxy comments Use doxy references to function and enums, also correct some names which became out of sync. --- source/blender/makesdna/DNA_anim_types.h | 2 +- source/blender/makesdna/DNA_object_force_types.h | 11 ++++++----- source/blender/makesdna/intern/dna_genfile.c | 2 +- 3 files changed, 8 insertions(+), 7 deletions(-) (limited to 'source/blender/makesdna') diff --git a/source/blender/makesdna/DNA_anim_types.h b/source/blender/makesdna/DNA_anim_types.h index ccc0b2e4fcb..c2f69093137 100644 --- a/source/blender/makesdna/DNA_anim_types.h +++ b/source/blender/makesdna/DNA_anim_types.h @@ -1107,7 +1107,7 @@ typedef enum eAnimData_Flag { /* Base Struct for Anim ------------------------------------- */ /** - * Used for BKE_animdata_from_id() + * Used for #BKE_animdata_from_id() * All ID-datablocks which have their own 'local' AnimData * should have the same arrangement in their structs. */ diff --git a/source/blender/makesdna/DNA_object_force_types.h b/source/blender/makesdna/DNA_object_force_types.h index 4b276a0aa85..edd5d305683 100644 --- a/source/blender/makesdna/DNA_object_force_types.h +++ b/source/blender/makesdna/DNA_object_force_types.h @@ -185,11 +185,12 @@ typedef struct EffectorWeights { /* EffectorWeights->flag */ #define EFF_WEIGHT_DO_HAIR 1 -/* Point cache file data types: - * - used as (1 << flag) so poke jahka if you reach the limit of 15 - * - to add new data types update: - * - BKE_ptcache_data_size() - * - ptcache_file_init_pointers() +/** + * Point cache file data types: + * - Used as `(1 << flag)` so poke jahka if you reach the limit of 15. + * - To add new data types update: + * - #BKE_ptcache_data_size() + * - #ptcache_file_pointers_init() */ #define BPHYS_DATA_INDEX 0 #define BPHYS_DATA_LOCATION 1 diff --git a/source/blender/makesdna/intern/dna_genfile.c b/source/blender/makesdna/intern/dna_genfile.c index b31fa8e0589..863aebd86e8 100644 --- a/source/blender/makesdna/intern/dna_genfile.c +++ b/source/blender/makesdna/intern/dna_genfile.c @@ -922,7 +922,7 @@ static bool elem_exists( * * Passing olddata=NULL doesn't work reliably for existence checks; it will * return NULL both when the field is found at offset 0 and when it is not - * found at all. For field existence checks, use elem_exists() instead. + * found at all. For field existence checks, use #elem_exists() instead. * * \param sdna: Old SDNA * \param type: Current field type name -- cgit v1.2.3