Cleanup: use doxy comments for wmOperatoType.flag

This commit is contained in:
2019-05-29 01:00:16 +10:00
parent 916c2d0e7f
commit d6643b57bc

View File

@@ -135,31 +135,39 @@ typedef struct wmGenericCallback {
/* ************** wmOperatorType ************************ */ /* ************** wmOperatorType ************************ */
/* flag */ /** #wmOperatorType.flag */
enum { enum {
OPTYPE_REGISTER = (1 << 0), /* register operators in stack after finishing */ /** Register operators in stack after finishing (needed for redo). */
OPTYPE_UNDO = (1 << 1), /* do undo push after after */ OPTYPE_REGISTER = (1 << 0),
OPTYPE_BLOCKING = (1 << 2), /* let blender grab all input from the WM (X11) */ /** Do an undo push after the operator runs. */
OPTYPE_UNDO = (1 << 1),
/** Let Blender grab all input from the WM (X11) */
OPTYPE_BLOCKING = (1 << 2),
OPTYPE_MACRO = (1 << 3), OPTYPE_MACRO = (1 << 3),
/* grabs the cursor and optionally enables continuous cursor wrapping. */ /** Grabs the cursor and optionally enables continuous cursor wrapping. */
OPTYPE_GRAB_CURSOR_XY = (1 << 4), OPTYPE_GRAB_CURSOR_XY = (1 << 4),
OPTYPE_GRAB_CURSOR_X = (1 << 5), /* Only X axis. */ /** Only warp on the X axis. */
OPTYPE_GRAB_CURSOR_Y = (1 << 6), /* Only Y axis. */ OPTYPE_GRAB_CURSOR_X = (1 << 5),
/** Only warp on the Y axis. */
OPTYPE_GRAB_CURSOR_Y = (1 << 6),
OPTYPE_PRESET = (1 << 7), /* show preset menu */ /** Show preset menu. */
OPTYPE_PRESET = (1 << 7),
/* some operators are mainly for internal use /**
* and don't make sense to be accessed from the * Some operators are mainly for internal use and don't make sense
* search menu, even if poll() returns true. * to be accessed from the search menu, even if poll() returns true.
* currently only used for the search toolbox */ * Currently only used for the search toolbox.
*/
OPTYPE_INTERNAL = (1 << 8), OPTYPE_INTERNAL = (1 << 8),
OPTYPE_LOCK_BYPASS = (1 << 9), /* Allow operator to run when interface is locked */ /** Allow operator to run when interface is locked. */
OPTYPE_UNDO_GROUPED = OPTYPE_LOCK_BYPASS = (1 << 9),
(1 << 10), /* Special type of undo which doesn't store itself multiple times */ /** Special type of undo which doesn't store itself multiple times. */
OPTYPE_USE_EVAL_DATA = OPTYPE_UNDO_GROUPED = (1 << 10),
(1 << 11), /* Need evaluated data (i.e. a valid, up-to-date depsgraph for current context) */ /** Need evaluated data (i.e. a valid, up-to-date depsgraph for current context). */
OPTYPE_USE_EVAL_DATA = (1 << 11),
}; };
/** For #WM_cursor_grab_enable wrap axis. */ /** For #WM_cursor_grab_enable wrap axis. */