mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-13 14:58:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Mark some function arguments as [consumed] in the docs.

Browse Source 
The argument argv of job_start() and channel_from_job() will be
freed. Mark them as such in the comments of this functions.
This commit is contained in:
oni-link
2014-11-08 03:28:06 +01:00
parent 70cb863096
commit cf95d27689
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/nvim/msgpack_rpc/channel.c
View File

@@ -119,7 +119,7 @@ void channel_teardown(void)
/// Creates an API channel by starting a job and connecting to its /// Creates an API channel by starting a job and connecting to its
/// stdin/stdout. stderr is forwarded to the editor error stream. /// 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 /// @return The channel id
uint64_t channel_from_job(char **argv) uint64_t channel_from_job(char **argv)
{ {

3
src/nvim/os/job.c
View File

@@ -105,7 +105,8 @@ void job_teardown(void)
/// Tries to start a new job. /// Tries to start a new job.
/// ///
/// @param argv Argument vector for the process. The first item is the /// @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 data Caller data that will be associated with the job
/// @param writable If true the job stdin will be available for writing with /// @param writable If true the job stdin will be available for writing with
/// job_write, otherwise it will be redirected to /dev/null /// job_write, otherwise it will be redirected to /dev/null