Mercurial > forge
changeset 11580:7f7e874d2572 octave-forge
instrument:control: fix gpib timeout documentation
line wrap: on
line diff
--- a/main/instrument-control/src/gpib/gpib.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/gpib/gpib.cc Sun Mar 31 12:07:47 2013 +0000 @@ -35,7 +35,7 @@ \n\ Open gpib interface.\n \ \n\ -@var{gpibid} - the interface number. @*\ +@var{gpibid} - the interface number.\n \ @var{timeout} - the interface timeout value. If omitted defaults to blocking call.\n \ \n\ The gpib() shall return instance of @var{octave_gpib} class as the result @var{gpib}.\n \
--- a/main/instrument-control/src/gpib/gpib_close.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/gpib/gpib_close.cc Sun Mar 31 12:07:47 2013 +0000 @@ -32,7 +32,7 @@ \n\ Close the interface and release a file descriptor.\n \ \n\ -@var{gpib} - instance of @var{octave_gpib} class.@*\ +@var{gpib} - instance of @var{octave_gpib} class.\n \ @end deftypefn") { #ifndef BUILD_GPIB
--- a/main/instrument-control/src/gpib/gpib_read.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/gpib/gpib_read.cc Sun Mar 31 12:07:47 2013 +0000 @@ -44,7 +44,7 @@ \n\ Read from gpib interface.\n \ \n\ -@var{gpib} - instance of @var{octave_gpib} class.@*\ +@var{gpib} - instance of @var{octave_gpib} class.\n \ @var{n} - number of bytes to attempt to read of type Integer.\n \ \n\ The gpib_read() shall return number of bytes successfully read in @var{count} as Integer and the bytes themselves in @var{data} as uint8 array.\n \
--- a/main/instrument-control/src/gpib/gpib_timeout.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/gpib/gpib_timeout.cc Sun Mar 31 12:07:47 2013 +0000 @@ -32,10 +32,10 @@ @deftypefn {Loadable Function} {} gpib_timeout (@var{gpib}, @var{timeout})\n \ @deftypefnx {Loadable Function} {@var{t} = } gpib_timeout (@var{gpib})\n \ \n\ -Set new or get existing gpib interface timeout parameter used for gpib_read() requests. The timeout value is specified in tenths of a second.\n \ +Set new or get existing gpib interface timeout parameter. The timeout value is valid from 0 to 17.\n \ \n\ -@var{gpib} - instance of @var{octave_gpib} class.@*\ -@var{timeout} - gpib_read() timeout value in tenths of a second. Value of -1 means a blocking call. Maximum value of 255 (i.e. 25.5 seconds).\n \ +@var{gpib} - instance of @var{octave_gpib} class.\n \ +@var{timeout} - Value of 0 means never timeout, 11 means one second and 17 means 1000 seconds (see GPIB documentation (ibtmo) for further details)\n \ \n\ If @var{timeout} parameter is omitted, the gpib_timeout() shall return current timeout value as the result @var{t}.\n \ @end deftypefn")
--- a/main/instrument-control/src/gpib/gpib_write.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/gpib/gpib_write.cc Sun Mar 31 12:07:47 2013 +0000 @@ -36,7 +36,7 @@ \n\ Write data to a gpib interface.\n \ \n\ -@var{gpib} - instance of @var{octave_gpib} class.@*\ +@var{gpib} - instance of @var{octave_gpib} class.\n \ @var{data} - data to be written to the gpib interface. Can be either of String or uint8 type.\n \ \n\ Upon successful completion, gpib_write() shall return the number of bytes written as the result @var{n}.\n \
--- a/main/instrument-control/src/tcp/tcp.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/tcp/tcp.cc Sun Mar 31 12:07:47 2013 +0000 @@ -32,8 +32,8 @@ \n\ Open tcp interface.\n \ \n\ -@var{ipaddress} - the ip address of type String. If omitted defaults to '127.0.0.1'. @*\ -@var{port} - the port number to connect. If omitted defaults to 23. @*\ +@var{ipaddress} - the ip address of type String. If omitted defaults to '127.0.0.1'.\n \ +@var{port} - the port number to connect. If omitted defaults to 23.\n \ @var{timeout} - the interface timeout value. If omitted defaults to blocking call.\n \ \n\ The tcp() shall return instance of @var{octave_tcp} class as the result @var{tcp}.\n \
--- a/main/instrument-control/src/tcp/tcp_close.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/tcp/tcp_close.cc Sun Mar 31 12:07:47 2013 +0000 @@ -32,7 +32,7 @@ \n\ Close the interface and release a file descriptor.\n \ \n\ -@var{tcp} - instance of @var{octave_tcp} class.@*\ +@var{tcp} - instance of @var{octave_tcp} class.\n \ @end deftypefn") { #ifndef BUILD_TCP
--- a/main/instrument-control/src/tcp/tcp_read.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/tcp/tcp_read.cc Sun Mar 31 12:07:47 2013 +0000 @@ -44,7 +44,7 @@ \n\ Read from tcp interface.\n \ \n\ -@var{tcp} - instance of @var{octave_tcp} class.@*\ +@var{tcp} - instance of @var{octave_tcp} class.\n \ @var{n} - number of bytes to attempt to read of type Integer\n \ @var{timeout} - timeout in ms if different from default of type Integer\n \ \n\
--- a/main/instrument-control/src/tcp/tcp_timeout.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/tcp/tcp_timeout.cc Sun Mar 31 12:07:47 2013 +0000 @@ -33,7 +33,7 @@ \n\ Set new or get existing tcp interface timeout parameter used for tcp_read() requests. The timeout value is specified in milliseconds.\n \ \n\ -@var{tcp} - instance of @var{octave_tcp} class.@*\ +@var{tcp} - instance of @var{octave_tcp} class.\n \ @var{timeout} - tcp_read() timeout value in milliseconds. Value of -1 means a blocking call.\n \ \n\ If @var{timeout} parameter is omitted, the tcp_timeout() shall return current timeout value as the result @var{t}.\n \
--- a/main/instrument-control/src/tcp/tcp_write.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/tcp/tcp_write.cc Sun Mar 31 12:07:47 2013 +0000 @@ -32,7 +32,7 @@ \n\ Write data to a tcp interface.\n \ \n\ -@var{tcp} - instance of @var{octave_tcp} class.@*\ +@var{tcp} - instance of @var{octave_tcp} class.\n \ @var{data} - data to be written to the tcp interface. Can be either of String or uint8 type.\n \ \n\ Upon successful completion, tcp_write() shall return the number of bytes written as the result @var{n}.\n \
--- a/main/instrument-control/src/usbtmc/usbtmc.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/usbtmc/usbtmc.cc Sun Mar 31 12:07:47 2013 +0000 @@ -36,7 +36,7 @@ \n\ Open usbtmc interface.\n \ \n\ -@var{path} - the interface path of type String. If omitted defaults to '/dev/usbtmc0'. @*\ +@var{path} - the interface path of type String. If omitted defaults to '/dev/usbtmc0'.\n \ \n\ The usbtmc() shall return instance of @var{octave_usbtmc} class as the result @var{usbtmc}.\n \ @end deftypefn")
--- a/main/instrument-control/src/usbtmc/usbtmc_close.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/usbtmc/usbtmc_close.cc Sun Mar 31 12:07:47 2013 +0000 @@ -32,7 +32,7 @@ \n\ Close the interface and release a file descriptor.\n \ \n\ -@var{usbtmc} - instance of @var{octave_usbtmc} class.@*\ +@var{usbtmc} - instance of @var{octave_usbtmc} class.\n \ @end deftypefn") { #ifndef BUILD_USBTMC
--- a/main/instrument-control/src/usbtmc/usbtmc_read.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/usbtmc/usbtmc_read.cc Sun Mar 31 12:07:47 2013 +0000 @@ -36,7 +36,7 @@ \n\ Read from usbtmc slave device.\n \ \n\ -@var{usbtmc} - instance of @var{octave_usbtmc} class.@*\ +@var{usbtmc} - instance of @var{octave_usbtmc} class.\n \ @var{n} - number of bytes to attempt to read of type Integer.\n \ \n\ The usbtmc_read() shall return number of bytes successfully read in @var{count} as Integer and the bytes themselves in @var{data} as uint8 array.\n \
--- a/main/instrument-control/src/usbtmc/usbtmc_write.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/usbtmc/usbtmc_write.cc Sun Mar 31 12:07:47 2013 +0000 @@ -34,7 +34,7 @@ \n\ Write data to a usbtmc slave device.\n \ \n\ -@var{usbtmc} - instance of @var{octave_usbtmc} class.@*\ +@var{usbtmc} - instance of @var{octave_usbtmc} class.\n \ @var{data} - data, of type uint8, to be written to the slave device.\n \ \n\ Upon successful completion, usbtmc_write() shall return the number of bytes written as the result @var{n}.\n \
--- a/main/instrument-control/src/vxi11/vxi11.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/vxi11/vxi11.cc Sun Mar 31 12:07:47 2013 +0000 @@ -36,7 +36,7 @@ \n\ Open vxi11 interface.\n \ \n\ -@var{path} - the ip address of type String. If omitted defaults to '127.0.0.1'. @*\ +@var{path} - the ip address of type String. If omitted defaults to '127.0.0.1'.\n \ \n\ The vxi11() shall return instance of @var{octave_vxi11} class as the result @var{vxi11}.\n \ @end deftypefn")
--- a/main/instrument-control/src/vxi11/vxi11_close.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/vxi11/vxi11_close.cc Sun Mar 31 12:07:47 2013 +0000 @@ -32,7 +32,7 @@ \n\ Close the interface and release a file descriptor.\n \ \n\ -@var{vxi11} - instance of @var{octave_vxi11} class.@*\ +@var{vxi11} - instance of @var{octave_vxi11} class.\n \ @end deftypefn") { #ifndef BUILD_VXI11
--- a/main/instrument-control/src/vxi11/vxi11_read.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/vxi11/vxi11_read.cc Sun Mar 31 12:07:47 2013 +0000 @@ -34,7 +34,7 @@ \n\ Read from vxi11 slave device.\n \ \n\ -@var{vxi11} - instance of @var{octave_vxi11} class.@*\ +@var{vxi11} - instance of @var{octave_vxi11} class.\n \ @var{n} - number of bytes to attempt to read of type Integer.\n \ \n\ The vxi11_read() shall return number of bytes successfully read in @var{count} as Integer and the bytes themselves in @var{data} as uint8 array.\n \
--- a/main/instrument-control/src/vxi11/vxi11_write.cc Thu Mar 28 17:40:22 2013 +0000 +++ b/main/instrument-control/src/vxi11/vxi11_write.cc Sun Mar 31 12:07:47 2013 +0000 @@ -32,7 +32,7 @@ \n\ Write data to a vxi11 slave device.\n \ \n\ -@var{vxi11} - instance of @var{octave_vxi11} class.@*\ +@var{vxi11} - instance of @var{octave_vxi11} class.\n \ @var{data} - data to be written to the slave device. Can be either of String or uint8 type.\n \ \n\ Upon successful completion, vxi11_write() shall return the number of bytes written as the result @var{n}.\n \