From cf95d27689ac48c48c6ff2f360439beeac3976af Mon Sep 17 00:00:00 2001 From: oni-link Date: Sat, 8 Nov 2014 03:28:06 +0100 Subject: Mark some function arguments as [consumed] in the docs. The argument argv of job_start() and channel_from_job() will be freed. Mark them as such in the comments of this functions. --- src/nvim/msgpack_rpc/channel.c | 2 +- src/nvim/os/job.c | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/nvim/msgpack_rpc/channel.c b/src/nvim/msgpack_rpc/channel.c index aa6008558f..da1dc8d1b5 100644 --- a/src/nvim/msgpack_rpc/channel.c +++ b/src/nvim/msgpack_rpc/channel.c @@ -119,7 +119,7 @@ void channel_teardown(void) /// Creates an API channel by starting a job and connecting to its /// stdin/stdout. stderr is forwarded to the editor error stream. /// -/// @param argv The argument vector for the process +/// @param argv The argument vector for the process. [consumed] /// @return The channel id uint64_t channel_from_job(char **argv) { diff --git a/src/nvim/os/job.c b/src/nvim/os/job.c index 551a7d1c87..17872ab9c9 100644 --- a/src/nvim/os/job.c +++ b/src/nvim/os/job.c @@ -105,7 +105,8 @@ void job_teardown(void) /// Tries to start a new job. /// /// @param argv Argument vector for the process. The first item is the -/// executable to run. +/// executable to run. +/// [consumed] /// @param data Caller data that will be associated with the job /// @param writable If true the job stdin will be available for writing with /// job_write, otherwise it will be redirected to /dev/null -- cgit