Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2020-06-27 07:34:16 +0300
committerCampbell Barton <ideasman42@gmail.com>2020-06-27 08:43:20 +0300
commit4b96f4783197c6bbf34230385b711d685df2b545 (patch)
treebb49734d45a9d4e2e99e564ab49c431dcab99bfb /source/blender/editors/include/ED_anim_api.h
parentc1c5dff7c0a4950d53a45ea5d49b2f0dd6c1388b (diff)
Docs: correct invalid doxygen params & references
Diffstat (limited to 'source/blender/editors/include/ED_anim_api.h')
-rw-r--r--source/blender/editors/include/ED_anim_api.h21
1 files changed, 13 insertions, 8 deletions
diff --git a/source/blender/editors/include/ED_anim_api.h b/source/blender/editors/include/ED_anim_api.h
index f46ef3ff1be..3aecec0d6b6 100644
--- a/source/blender/editors/include/ED_anim_api.h
+++ b/source/blender/editors/include/ED_anim_api.h
@@ -281,10 +281,13 @@ typedef enum eAnim_Update_Flags {
/* filtering flags - under what circumstances should a channel be returned */
typedef enum eAnimFilter_Flags {
- /** data which channel represents is fits the dopesheet filters
- * (i.e. scene visibility criteria) */
- /* XXX: it's hard to think of any examples where this *ISN'T* the case...
- * perhaps becomes implicit?. */
+ /**
+ * Data which channel represents is fits the dope-sheet filters
+ * (i.e. scene visibility criteria).
+ *
+ * XXX: it's hard to think of any examples where this *ISN'T* the case...
+ * perhaps becomes implicit?.
+ */
ANIMFILTER_DATA_VISIBLE = (1 << 0),
/** channel is visible within the channel-list hierarchy
* (i.e. F-Curves within Groups in ActEdit) */
@@ -297,7 +300,7 @@ typedef enum eAnimFilter_Flags {
/** for its type, channel should be "active" one */
ANIMFILTER_ACTIVE = (1 << 4),
- /** channel is a child of the active group (* Actions speciality) */
+ /** channel is a child of the active group (* Actions specialty) */
ANIMFILTER_ACTGROUPED = (1 << 5),
/** channel must be selected/not-selected, but both must not be set together */
@@ -310,8 +313,10 @@ typedef enum eAnimFilter_Flags {
* for Graph Editor's option for keys on select curves only */
ANIMFILTER_SELEDIT = (1 << 9),
- /** flags used to enforce certain data types
- * \node the ones for curves and NLA tracks were redundant and have been removed for now...
+ /**
+ * Flags used to enforce certain data types.
+ *
+ * \note The ones for curves and NLA tracks were redundant and have been removed for now.
*/
ANIMFILTER_ANIMDATA = (1 << 10),
@@ -321,7 +326,7 @@ typedef enum eAnimFilter_Flags {
/** for checking if we should keep some collapsed channel around (internal use only!) */
ANIMFILTER_TMP_PEEK = (1 << 30),
- /** ignore ONLYSEL flag from filterflag, (internal use only!) */
+ /** Ignore ONLYSEL flag from #bDopeSheet.filterflag (internal use only!) */
ANIMFILTER_TMP_IGNORE_ONLYSEL = (1u << 31),
} eAnimFilter_Flags;