diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2016-10-31 02:03:37 +0100 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2016-10-31 02:21:16 +0100 |
| commit | b172f9904f03331041c1c53d5c243e7c9b7c4284 (patch) | |
| tree | 8131885ac6f1cd7f03aa2d5da32f4b556eac792b /src/nvim/eval/typval_encode.h | |
| parent | ed198737fd739dcd4960763028a73e4efd83c452 (diff) | |
| download | rneovim-b172f9904f03331041c1c53d5c243e7c9b7c4284.tar.gz rneovim-b172f9904f03331041c1c53d5c243e7c9b7c4284.tar.bz2 rneovim-b172f9904f03331041c1c53d5c243e7c9b7c4284.zip | |
doc: eval/typval_encode.h
Annotate TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS to aid code navigation.
Diffstat (limited to 'src/nvim/eval/typval_encode.h')
| -rw-r--r-- | src/nvim/eval/typval_encode.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/nvim/eval/typval_encode.h b/src/nvim/eval/typval_encode.h index 98fa7b26c6..868877bd47 100644 --- a/src/nvim/eval/typval_encode.h +++ b/src/nvim/eval/typval_encode.h @@ -212,10 +212,9 @@ static inline size_t tv_strlen(const typval_T *const tv) : strlen((char *) tv->vval.v_string)); } -/// Define functions which convert VimL value to something else -/// -/// Creates function `vim_to_{name}(firstargtype firstargname, typval_T *const -/// tv)` which returns OK or FAIL and helper functions. +/// Define functions to convert a VimL value: +/// `{name}_convert_one_value(...)` +/// `encode_vim_to_{name}(...)` /// /// @param scope Scope of the main function: either nothing or `static`. /// @param name Name of the target converter. @@ -224,6 +223,7 @@ static inline size_t tv_strlen(const typval_T *const tv) /// @param firstargname Name of the first argument. #define TYPVAL_ENCODE_DEFINE_CONV_FUNCTIONS(scope, name, firstargtype, \ firstargname) \ +/* Returns OK or FAIL */ \ static int name##_convert_one_value(firstargtype firstargname, \ MPConvStack *const mpstack, \ typval_T *const tv, \ |