diff options
author | ZyX <kp-pav@ya.ru> | 2014-05-10 00:53:36 +0400 |
---|---|---|
committer | Thiago de Arruda <tpadilha84@gmail.com> | 2014-06-02 11:04:04 -0300 |
commit | 880957ad4e3fc0ff681025f5e29c5eccf797c564 (patch) | |
tree | c222654d93e73760c98a0aca92411942ca94237a /src/nvim/os/channel.h | |
parent | 52a9a5b0b0c53a1481d901f39ed0d1e7e86c3853 (diff) | |
download | rneovim-880957ad4e3fc0ff681025f5e29c5eccf797c564.tar.gz rneovim-880957ad4e3fc0ff681025f5e29c5eccf797c564.tar.bz2 rneovim-880957ad4e3fc0ff681025f5e29c5eccf797c564.zip |
Move documentation from function declarations to definitions
Uses a perl script to move it (scripts/movedocs.pl)
Diffstat (limited to 'src/nvim/os/channel.h')
-rw-r--r-- | src/nvim/os/channel.h | 27 |
1 files changed, 1 insertions, 26 deletions
diff --git a/src/nvim/os/channel.h b/src/nvim/os/channel.h index b88cd2445f..47182594b1 100644 --- a/src/nvim/os/channel.h +++ b/src/nvim/os/channel.h @@ -2,49 +2,24 @@ #define NVIM_OS_CHANNEL_H #include <uv.h> +#include <msgpack.h> #include "nvim/vim.h" #define EVENT_MAXLEN 512 -/// Initializes the module void channel_init(void); -/// Teardown the module void channel_teardown(void); -/// Creates an API channel from a libuv stream representing a tcp or -/// pipe/socket client connection -/// -/// @param stream The established connection void channel_from_stream(uv_stream_t *stream); -/// 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 void channel_from_job(char **argv); -/// Sends event/data to channel -/// -/// @param id The channel id. If 0, the event will be sent to all -/// channels that have subscribed to the event type -/// @param type The event type, an arbitrary string -/// @param obj The event data -/// @return True if the data was sent successfully, false otherwise. bool channel_send_event(uint64_t id, char *type, typval_T *data); -/// Subscribes to event broadcasts -/// -/// @param id The channel id -/// @param event The event type string void channel_subscribe(uint64_t id, char *event); -/// Unsubscribes to event broadcasts -/// -/// @param id The channel id -/// @param event The event type string void channel_unsubscribe(uint64_t id, char *event); #endif // NVIM_OS_CHANNEL_H - |