client API: nothing uses the result parameter of mpv_command_node()

Add a comment about this to avoid confusing users of this function. The
parameter is essentially unused, but exists so that we don't need to
add extra APIs if the need for it arises.
This commit is contained in:
wm4 2014-11-02 17:46:53 +01:00
parent 3a95a0887c
commit 61b06f3756
1 changed files with 2 additions and 0 deletions

View File

@ -699,6 +699,8 @@ int mpv_command(mpv_handle *ctx, const char **args);
* function succeeds, this is set to command-specific return * function succeeds, this is set to command-specific return
* data. You must call mpv_free_node_contents() to free it * data. You must call mpv_free_node_contents() to free it
* (again, only if the command actually succeeds). * (again, only if the command actually succeeds).
* Currently, no command uses this, but that can change in
* the future.
* @return error code (the result parameter is not set on error) * @return error code (the result parameter is not set on error)
*/ */
int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result); int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result);