docs: for deprecated functions/types show original C decl in comment

Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
This commit is contained in:
Christopher Arndt 2023-05-22 19:02:38 +02:00
parent 309e45e22a
commit e06f62da8c
1 changed files with 12 additions and 11 deletions

View File

@ -132,8 +132,9 @@ proc free*(`ptr`: pointer) {.importc: "jack_free".}
proc clientOpen*(clientName: cstring; options: cint; status: ptr cint): ClientP {. proc clientOpen*(clientName: cstring; options: cint; status: ptr cint): ClientP {.
varargs, importc: "jack_client_open".} varargs, importc: "jack_client_open".}
# DEPRECATED #[ DEPRECATED
# proc clientNew*(clientName: cstring): ClientP {.importc: "jack_client_new".} jack_client_t * jack_client_new (const char *client_name)
]#
# int jack_client_close (jack_client_t *client) # int jack_client_close (jack_client_t *client)
proc clientClose*(client: ClientP): cint {.importc: "jack_client_close"} proc clientClose*(client: ClientP): cint {.importc: "jack_client_close"}
@ -175,9 +176,9 @@ proc getClientPid*(name: cstring): cint {.importc: "jack_get_client_pid".}
# int jack_is_realtime (jack_client_t *client) # int jack_is_realtime (jack_client_t *client)
proc isRealtime*(client: ClientP): cint {.importc: "jack_is_realtime".} proc isRealtime*(client: ClientP): cint {.importc: "jack_is_realtime".}
# DEPRECATED #[ DEPRECATED
# proc threadWait*(client: ClientP; status: cint): NFrames {. jack_nframes_t jack_thread_wait (jack_client_t *client, int status)
# importc: "jack_thread_wait".} ]#
# jack_nframes_t jack_cycle_wait (jack_client_t* client) # jack_nframes_t jack_cycle_wait (jack_client_t* client)
proc cycleWait*(client: ClientP): NFrames {.importc: "jack_cycle_wait".} proc cycleWait*(client: ClientP): NFrames {.importc: "jack_cycle_wait".}
@ -250,9 +251,9 @@ proc getSampleRate*(client: ClientP): NFrames {.importc: "jack_get_sample_rate".
# jack_nframes_t jack_get_buffer_size (jack_client_t *) # jack_nframes_t jack_get_buffer_size (jack_client_t *)
proc getBufferSize*(client: ClientP): NFrames {.importc: "jack_get_buffer_size".} proc getBufferSize*(client: ClientP): NFrames {.importc: "jack_get_buffer_size".}
# DEPRECATED #[ DEPRECATED
# proc engineTakeoverTimebase*(a1: ClientP): cint {. int jack_engine_takeover_timebase (jack_client_t *)
# importc: "jack_engine_takeover_timebase".} ]#
# float jack_cpu_load (jack_client_t *client) # float jack_cpu_load (jack_client_t *client)
proc cpuLoad*(client: ClientP): cfloat {.importc: "jack_cpu_load".} proc cpuLoad*(client: ClientP): cfloat {.importc: "jack_cpu_load".}
@ -316,11 +317,11 @@ proc portGetAllConnections*(client: ClientP; port: PortP): cstringArray {.
importc: "jack_port_get_all_connections".} importc: "jack_port_get_all_connections".}
#[ DEPRECATED #[ DEPRECATED
proc portTie*(src: PortP; dst: PortP): cint {.importc: "jack_port_tie".} int jack_port_tie (jack_port_t *src, jack_port_t *dst)
proc portUntie*(port: PortP): cint {.importc: "jack_port_untie".} int jack_port_untie (jack_port_t *port)
proc portSetName*(port: PortP; portName: cstring): cint {.importc: "jack_port_set_name".} int jack_port_set_name (jack_port_t *port, const char *port_name)
]# ]#
# int jack_port_rename (jack_client_t* client, jack_port_t *port, const char *port_name) # int jack_port_rename (jack_client_t* client, jack_port_t *port, const char *port_name)