diff options
Diffstat (limited to 'source/blender/editors/include/ED_numinput.h')
| -rw-r--r-- | source/blender/editors/include/ED_numinput.h | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/source/blender/editors/include/ED_numinput.h b/source/blender/editors/include/ED_numinput.h index 697a236341f..b13f228b1ec 100644 --- a/source/blender/editors/include/ED_numinput.h +++ b/source/blender/editors/include/ED_numinput.h @@ -78,12 +78,16 @@ struct UnitSettings; /** * 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). + * - 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); |