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>2019-06-24 14:41:55 +0300
committerCampbell Barton <ideasman42@gmail.com>2019-06-24 14:41:55 +0300
commit6dfdf1f82d201faa24b0095109599bdab26f024f (patch)
tree18daf41b5048c49b5ef48decdd12f7f61e66f7c8 /source/blender/makesdna/DNA_windowmanager_types.h
parent1c94030238bb37918c4cd3256e0acb0b7099579d (diff)
Cleanup: use doxy comments for DNA_windowmanager_types.h
Diffstat (limited to 'source/blender/makesdna/DNA_windowmanager_types.h')
-rw-r--r--source/blender/makesdna/DNA_windowmanager_types.h24
1 files changed, 14 insertions, 10 deletions
diff --git a/source/blender/makesdna/DNA_windowmanager_types.h b/source/blender/makesdna/DNA_windowmanager_types.h
index c87d50fedaa..4ccb23045df 100644
--- a/source/blender/makesdna/DNA_windowmanager_types.h
+++ b/source/blender/makesdna/DNA_windowmanager_types.h
@@ -303,7 +303,7 @@ typedef struct wmOperatorTypeMacro {
struct PointerRNA *ptr;
} wmOperatorTypeMacro;
-/* partial copy of the event, for matching by eventhandler */
+/* Partial copy of the event, for matching by event handler. */
typedef struct wmKeyMapItem {
struct wmKeyMapItem *next, *prev;
@@ -342,7 +342,7 @@ typedef struct wmKeyMapItem {
struct PointerRNA *ptr;
} wmKeyMapItem;
-/* used instead of wmKeyMapItem for diff keymaps */
+/** Used instead of wmKeyMapItem for diff keymaps. */
typedef struct wmKeyMapDiffItem {
struct wmKeyMapDiffItem *next, *prev;
@@ -350,7 +350,7 @@ typedef struct wmKeyMapDiffItem {
wmKeyMapItem *add_item;
} wmKeyMapDiffItem;
-/* wmKeyMapItem.flag */
+/** #wmKeyMapItem.flag */
enum {
KMI_INACTIVE = (1 << 0),
KMI_EXPANDED = (1 << 1),
@@ -358,7 +358,7 @@ enum {
KMI_UPDATE = (1 << 3),
};
-/* wmKeyMapItem.maptype */
+/** #wmKeyMapItem.maptype */
enum {
KMI_TYPE_KEYBOARD = 0,
KMI_TYPE_MOUSE = 1,
@@ -398,7 +398,7 @@ typedef struct wmKeyMap {
const void *modal_items;
} wmKeyMap;
-/* wmKeyMap.flag */
+/** #wmKeyMap.flag */
enum {
KEYMAP_MODAL = (1 << 0), /* modal map, not using operatornames */
KEYMAP_USER = (1 << 1), /* user keymap */
@@ -438,14 +438,16 @@ typedef struct wmKeyConfig {
char _pad0[2];
} wmKeyConfig;
-/* wmKeyConfig.flag */
+/** #wmKeyConfig.flag */
enum {
KEYCONF_USER = (1 << 1), /* And what about (1 << 0)? */
KEYCONF_INIT_DEFAULT = (1 << 2), /* Has default keymap been initialized? */
};
-/* this one is the operator itself, stored in files for macros etc */
-/* operator + operatortype should be able to redo entirely, but for different contextes */
+/**
+ * This one is the operator itself, stored in files for macros etc.
+ * operator + operator-type should be able to redo entirely, but for different context's.
+ */
typedef struct wmOperator {
struct wmOperator *next, *prev;
@@ -478,7 +480,9 @@ typedef struct wmOperator {
char _pad[6];
} wmOperator;
-/* operator type return flags: exec(), invoke() modal(), return values */
+/**
+ * Operator type return flags: exec(), invoke() modal(), return values.
+ */
enum {
OPERATOR_RUNNING_MODAL = (1 << 0),
OPERATOR_CANCELLED = (1 << 1),
@@ -499,7 +503,7 @@ enum {
#define OPERATOR_RETVAL_CHECK(ret) \
(void)ret, BLI_assert(ret != 0 && (ret & OPERATOR_FLAGS_ALL) == ret)
-/* wmOperator flag */
+/** #wmOperator.flag */
enum {
/** low level flag so exec() operators can tell if they were invoked, use with care.
* Typically this shouldn't make any difference, but it rare cases its needed