diff options
| author | ZyX <kp-pav@yandex.ru> | 2016-03-09 02:28:12 +0300 |
|---|---|---|
| committer | ZyX <kp-pav@yandex.ru> | 2016-04-18 02:48:20 +0300 |
| commit | 2b0d46195be0792791171aa23d04ee7ba31c54c9 (patch) | |
| tree | 661b051f8a29b7daf85eaada3d924283f3544f14 /src/nvim/eval/decode.c | |
| parent | 0c598774d8f6358f9cdf86a56cbe1355b503907f (diff) | |
| download | rneovim-2b0d46195be0792791171aa23d04ee7ba31c54c9.tar.gz rneovim-2b0d46195be0792791171aa23d04ee7ba31c54c9.tar.bz2 rneovim-2b0d46195be0792791171aa23d04ee7ba31c54c9.zip | |
eval/decode: Clarify meaning of some pointer arguments
Diffstat (limited to 'src/nvim/eval/decode.c')
| -rw-r--r-- | src/nvim/eval/decode.c | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/nvim/eval/decode.c b/src/nvim/eval/decode.c index b31b21b4da..1303e288c3 100644 --- a/src/nvim/eval/decode.c +++ b/src/nvim/eval/decode.c @@ -81,8 +81,10 @@ static inline void create_special_dict(typval_T *const rettv, /// for error reporting and is also set when decoding is /// restarted due to the necessity of converting regular /// dictionary to a special map. -/// @param[out] next_map_special Is set to true when dictionary is converted -/// to a special map, otherwise not touched. +/// @param[out] next_map_special Is set to true when dictionary needs to be +/// converted to a special map, otherwise not +/// touched. Indicates that decoding has been +/// restarted. /// @param[out] didcomma True if previous token was comma. Is set to recorded /// value when decoder is restarted, otherwise unused. /// @param[out] didcolon True if previous token was colon. Is set to recorded @@ -223,7 +225,9 @@ static inline int json_decoder_pop(ValuesStackItem obj, /// @param[in] buf Buffer being converted. /// @param[in] buf_len Length of the buffer. /// @param[in,out] pp Pointer to the start of the string. Must point to '"'. -/// Is advanced to the closing '"'. +/// Is advanced to the closing '"'. Also see +/// json_decoder_pop(), it may set pp to another location +/// and alter next_map_special, didcomma and didcolon. /// @param[out] stack Object stack. /// @param[out] container_stack Container objects stack. /// @param[out] next_map_special Is set to true when dictionary is converted @@ -465,7 +469,9 @@ parse_json_string_ret: /// @param[in] buf_len Length of the buffer. /// @param[in,out] pp Pointer to the start of the number. Must point to /// a digit or a minus sign. Is advanced to the last -/// character of the number. +/// character of the number. Also see json_decoder_pop(), it +/// may set pp to another location and alter +/// next_map_special, didcomma and didcolon. /// @param[out] stack Object stack. /// @param[out] container_stack Container objects stack. /// @param[out] next_map_special Is set to true when dictionary is converted |