From 065b6cacf8b671f146009b7a709a38d3b4f07ff1 Mon Sep 17 00:00:00 2001 From: paul Date: Mon, 24 Nov 2008 10:43:49 +0000 Subject: [PATCH] mark jack_port_{,un}tie() as deprecated in docs git-svn-id: svn+ssh://jackaudio.org/trunk/jack@3114 0c269be4-1314-0410-8aa9-9f06e86f4224 --- jack/jack.h | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/jack/jack.h b/jack/jack.h index ff940cd..64ba8a7 100644 --- a/jack/jack.h +++ b/jack/jack.h @@ -605,29 +605,20 @@ const char **jack_port_get_all_connections (const jack_client_t *client, const jack_port_t *port); /** - * A client may call this on a pair of its own ports to - * semi-permanently wire them together. This means that - * a client that wants to direct-wire an input port to - * an output port can call this and then no longer - * have to worry about moving data between them. Any data - * arriving at the input port will appear automatically - * at the output port. - * - * The 'destination' port must be an output port. The 'source' - * port must be an input port. Both ports must belong to - * the same client. You cannot use this to tie ports between - * clients. That is what a connection is for. * - * @return 0 on success, otherwise a non-zero error code + * @deprecated This function will be removed from a future version + * of JACK. Do not use it. There is no replacement. It has + * turned out to serve essentially no purpose in real-life + * JACK clients. */ int jack_port_tie (jack_port_t *src, jack_port_t *dst); /** - * This undoes the effect of jack_port_tie(). The port - * should be same as the 'destination' port passed to - * jack_port_tie(). * - * @return 0 on success, otherwise a non-zero error code + * @deprecated This function will be removed from a future version + * of JACK. Do not use it. There is no replacement. It has + * turned out to serve essentially no purpose in real-life + * JACK clients. */ int jack_port_untie (jack_port_t *port);