diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-04-14 11:48:42 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-04-14 11:48:42 +0300 |
commit | eff8cc9cccdaa7248d9d869473704e9db69c2f41 (patch) | |
tree | 95c67fbd688b1f63dfef77372a7eaeb40aa15ec5 /source/blender/blenkernel/BKE_blender_version.h | |
parent | b7e5433890debe629a0677473ba920f743de3342 (diff) |
Cleanup: doxy comments
Use doxy references to function and enums,
also correct some names which became out of sync.
Diffstat (limited to 'source/blender/blenkernel/BKE_blender_version.h')
-rw-r--r-- | source/blender/blenkernel/BKE_blender_version.h | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/source/blender/blenkernel/BKE_blender_version.h b/source/blender/blenkernel/BKE_blender_version.h index 9c47cc9f22b..1b56e203947 100644 --- a/source/blender/blenkernel/BKE_blender_version.h +++ b/source/blender/blenkernel/BKE_blender_version.h @@ -20,21 +20,25 @@ * \ingroup bke */ -/* these lines are grep'd, watch out for our not-so-awesome regex - * and keep comment above the defines. - * Use STRINGIFY() rather than defining with quotes */ +/** + * The lines below use regex from scripts to extract their values, + * Keep this in mind when modifying this file and keep this comment above the defines. + * + * \note Use #STRINGIFY() rather than defining with quotes. + */ #define BLENDER_VERSION 280 #define BLENDER_SUBVERSION 55 -/* Several breakages with 280, e.g. collections vs layers */ +/** Several breakages with 280, e.g. collections vs layers. */ #define BLENDER_MINVERSION 280 #define BLENDER_MINSUBVERSION 0 -/* used by packaging tools */ -/* can be left blank, otherwise a,b,c... etc with no quotes */ +/** Used by packaging tools. */ +/** Can be left blank, otherwise a,b,c... etc with no quotes. */ #define BLENDER_VERSION_CHAR -/* alpha/beta/rc/release, docs use this */ +/** alpha/beta/rc/release, docs use this. */ #define BLENDER_VERSION_CYCLE beta -extern char versionstr[]; /* from blender.c */ +/** Defined in from blender.c */ +extern char versionstr[]; #endif /* __BKE_BLENDER_VERSION_H__ */ |