summaryrefslogtreecommitdiffstats
path: root/libmpv/client.h
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2014-11-02 17:46:53 +0100
committerwm4 <wm4@nowhere>2014-11-02 17:46:53 +0100
commit61b06f3756596d0e858db25f5293920eff29333c (patch)
tree105cddd0b0e08ef723550004dcc293c926bd99e6 /libmpv/client.h
parent3a95a0887c95b1d1ab505a568c922c7a514f5916 (diff)
downloadmpv-61b06f3756596d0e858db25f5293920eff29333c.tar.bz2
mpv-61b06f3756596d0e858db25f5293920eff29333c.tar.xz
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.
Diffstat (limited to 'libmpv/client.h')
-rw-r--r--libmpv/client.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/libmpv/client.h b/libmpv/client.h
index bc594cee6a..ec41881f24 100644
--- a/libmpv/client.h
+++ b/libmpv/client.h
@@ -699,6 +699,8 @@ int mpv_command(mpv_handle *ctx, const char **args);
* function succeeds, this is set to command-specific return
* data. You must call mpv_free_node_contents() to free it
* (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)
*/
int mpv_command_node(mpv_handle *ctx, mpv_node *args, mpv_node *result);