diff options
Diffstat (limited to 'source/blender/editors/include/ED_numinput.h')
| -rw-r--r-- | source/blender/editors/include/ED_numinput.h | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/source/blender/editors/include/ED_numinput.h b/source/blender/editors/include/ED_numinput.h index 5f90996988a..d4cb2110c2c 100644 --- a/source/blender/editors/include/ED_numinput.h +++ b/source/blender/editors/include/ED_numinput.h @@ -72,15 +72,18 @@ enum { struct UnitSettings; -/*********************** NumInput ********************************/ - -/* There are important things to note here for code using numinput: - * * Values passed to applyNumInput() should be valid and are stored as default ones (val_org), if it is not EDITED. - * * bool returned by applyNumInput should be used to decide whether to apply numinput-specific post-process to data. - * * *Once applyNumInput has been called*, hasNumInput returns a valid value to decide whether to use numinput - * as drawstr source or not (i.e. to call outputNumInput). +/* -------------------------------------------------------------------- */ +/** \name NumInput + * \{ */ + +/** + * There are important things to note here for code using numinput: + * - Values passed to #applyNumInput() should be valid and are stored as default ones (val_org), if it is not EDITED. + * - bool returned by #applyNumInput should be used to decide whether to apply numinput-specific post-process to data. + * - Once #applyNumInput has been called, #hasNumInput returns a valid value to decide whether to use numinput + * as drawstr source or not (i.e. to call #outputNumInput). * - * Those two steps have to be separated (so do not use a common call to hasNumInput() to do both in the same time!). + * Those two steps have to be separated (so do not use a common call to #hasNumInput() to do both in the same time!). */ void initNumInput(NumInput *n); @@ -94,4 +97,6 @@ bool handleNumInput(struct bContext *C, NumInput *n, const struct wmEvent *event bool user_string_to_number(bContext *C, const char *str, const struct UnitSettings *unit, int type, double *r_value); +/** \} */ + #endif /* __ED_NUMINPUT_H__ */ |