[Octave-cvsupdate] SF.net SVN: octave:[10994] trunk/octave-forge/main/instrument-control/src/ parallel

[<ean...@us...>]

Revision: 10994
          http://octave.svn.sourceforge.net/octave/?rev=10994&view=rev
Author:   eandrius
Date:     2012-09-10 13:11:53 +0000 (Mon, 10 Sep 2012)
Log Message:
-----------
instrument-control: parallel, texinfo help strings

Modified Paths:
--------------
    trunk/octave-forge/main/instrument-control/src/parallel/parallel.cc
    trunk/octave-forge/main/instrument-control/src/parallel/pp_close.cc
    trunk/octave-forge/main/instrument-control/src/parallel/pp_ctrl.cc
    trunk/octave-forge/main/instrument-control/src/parallel/pp_data.cc
    trunk/octave-forge/main/instrument-control/src/parallel/pp_datadir.cc
    trunk/octave-forge/main/instrument-control/src/parallel/pp_stat.cc

Modified: trunk/octave-forge/main/instrument-control/src/parallel/parallel.cc
===================================================================
--- trunk/octave-forge/main/instrument-control/src/parallel/parallel.cc	2012-09-09 21:55:23 UTC (rev 10993)
+++ trunk/octave-forge/main/instrument-control/src/parallel/parallel.cc	2012-09-10 13:11:53 UTC (rev 10994)
@@ -92,13 +92,23 @@
 }
 
 // PKG_ADD: autoload ("parallel", "instrument-control.oct");
-DEFUN_DLD (parallel, args, nargout, "")
+DEFUN_DLD (parallel, args, nargout, 
+"-*- texinfo -*-\n\
+@deftypefn {Loadable Function} {@var{parallel} = } parallel ([@var{path}], [@var{direction})\n \
+\n\
+Open Parallel interface.\n \
+\n\
+@var{path} - the interface path of type String. If omitted defaults to '/dev/parport0'.@*\
+@var{direction} - the direction of interface drivers of type Integer, see: @seealso{pp_datadir} for more info.\n \
+\n\
+The parallel() shall return instance of @var{octave_parallel} class as the result @var{parallel}.\n \
+@end deftypefn")
 {
 #ifdef __WIN32__
     error("parallel: Windows platform support is not yet implemented, go away...");
     return octave_value();
-#endif
-
+#endif   
+    
     int nargin = args.length();
 
     // Default values

Modified: trunk/octave-forge/main/instrument-control/src/parallel/pp_close.cc
===================================================================
--- trunk/octave-forge/main/instrument-control/src/parallel/pp_close.cc	2012-09-09 21:55:23 UTC (rev 10993)
+++ trunk/octave-forge/main/instrument-control/src/parallel/pp_close.cc	2012-09-10 13:11:53 UTC (rev 10994)
@@ -38,7 +38,14 @@
 #include "parallel.h"
 
 // PKG_ADD: autoload ("pp_close", "instrument-control.oct");
-DEFUN_DLD (pp_close, args, nargout, "")
+DEFUN_DLD (pp_close, args, nargout, 
+"-*- texinfo -*-\n\
+@deftypefn {Loadable Function} {} pp_close (@var{parallel})\n \
+\n\
+Close the interface and release a file descriptor.\n \
+\n\
+@var{parallel} - instance of @var{octave_serial} class.@*\
+@end deftypefn")
 {
     if (args.length() != 1 || args(0).type_id() != octave_parallel::static_type_id())
     {

Modified: trunk/octave-forge/main/instrument-control/src/parallel/pp_ctrl.cc
===================================================================
--- trunk/octave-forge/main/instrument-control/src/parallel/pp_ctrl.cc	2012-09-09 21:55:23 UTC (rev 10993)
+++ trunk/octave-forge/main/instrument-control/src/parallel/pp_ctrl.cc	2012-09-10 13:11:53 UTC (rev 10994)
@@ -38,7 +38,18 @@
 #include "parallel.h"
 
 // PKG_ADD: autoload ("pp_ctrl", "instrument-control.oct");
-DEFUN_DLD (pp_ctrl, args, nargout, "")
+DEFUN_DLD (pp_ctrl, args, nargout, 
+"-*- texinfo -*-\n\
+@deftypefn {Loadable Function} {} pp_ctrl (@var{parallel}, @var{ctrl})\n \
+@deftypefnx {Loadable Function} {@var{c} = } pp_ctrl (@var{parallel})\n \
+\n\
+Sets or Read the Control lines.\
+\n\
+@var{parallel} - instance of @var{octave_parallel} class.@*\
+@var{ctrl} - control parameter to be set of type Byte.\n \
+\n\
+If @var{ctrl} parameter is omitted, the pp_ctrl() shall return current Control lines state as the result @var{c}.\n \
+@end deftypefn")
 {
     if (args.length() < 1 || args.length() > 2 || args(0).type_id() != octave_parallel::static_type_id())
     {

Modified: trunk/octave-forge/main/instrument-control/src/parallel/pp_data.cc
===================================================================
--- trunk/octave-forge/main/instrument-control/src/parallel/pp_data.cc	2012-09-09 21:55:23 UTC (rev 10993)
+++ trunk/octave-forge/main/instrument-control/src/parallel/pp_data.cc	2012-09-10 13:11:53 UTC (rev 10994)
@@ -38,7 +38,18 @@
 #include "parallel.h"
 
 // PKG_ADD: autoload ("pp_data", "instrument-control.oct");
-DEFUN_DLD (pp_data, args, nargout, "")
+DEFUN_DLD (pp_data, args, nargout, 
+"-*- texinfo -*-\n\
+@deftypefn {Loadable Function} {} pp_data (@var{parallel}, @var{data})\n \
+@deftypefnx {Loadable Function} {@var{d} = } pp_data (@var{parallel})\n \
+\n\
+Sets or Read the Data lines.\
+\n\
+@var{parallel} - instance of @var{octave_parallel} class.@*\
+@var{data} - data parameter to be set of type Byte.\n \
+\n\
+If @var{data} parameter is omitted, the pp_data() shall return current Data lines state as the result @var{d}.\n \
+@end deftypefn")
 {
     if (args.length() < 1 || args.length() > 2 || args(0).type_id() != octave_parallel::static_type_id())
     {

Modified: trunk/octave-forge/main/instrument-control/src/parallel/pp_datadir.cc
===================================================================
--- trunk/octave-forge/main/instrument-control/src/parallel/pp_datadir.cc	2012-09-09 21:55:23 UTC (rev 10993)
+++ trunk/octave-forge/main/instrument-control/src/parallel/pp_datadir.cc	2012-09-10 13:11:53 UTC (rev 10994)
@@ -38,7 +38,22 @@
 #include "parallel.h"
 
 // PKG_ADD: autoload ("pp_datadir", "instrument-control.oct");
-DEFUN_DLD (pp_datadir, args, nargout, "")
+DEFUN_DLD (pp_datadir, args, nargout, 
+"-*- texinfo -*-\n\
+@deftypefn {Loadable Function} {} pp_datadir (@var{parallel}, @var{direction})\n \
+@deftypefnx {Loadable Function} {@var{dir} = } pp_datadir (@var{parallel})\n \
+\n\
+Controls the Data line drivers. Normally the computer's parallel port will drive the data lines, \
+but for byte-wide transfers from the peripheral to the host it is useful to turn off those drivers \
+and let the peripheral drive the signals. (If the drivers on the computer's parallel port are left \
+on when this happens, the port might be damaged.)\n \
+\n\
+@var{parallel} - instance of @var{octave_parallel} class.@*\
+@var{direction} - direction parameter of type Integer. Supported values: 0 - the drivers are turned on \
+(Output/Forward direction); 1 - the drivers are turned off (Input/Reverse direction).\n \
+\n\
+If @var{direction} parameter is omitted, the pp_datadir() shall return current Data direction as the result @var{dir}.\n \
+@end deftypefn")
 {
     if (args.length() < 1 || args.length() > 2 || args(0).type_id() != octave_parallel::static_type_id())
     {

Modified: trunk/octave-forge/main/instrument-control/src/parallel/pp_stat.cc
===================================================================
--- trunk/octave-forge/main/instrument-control/src/parallel/pp_stat.cc	2012-09-09 21:55:23 UTC (rev 10993)
+++ trunk/octave-forge/main/instrument-control/src/parallel/pp_stat.cc	2012-09-10 13:11:53 UTC (rev 10994)
@@ -38,7 +38,16 @@
 #include "parallel.h"
 
 // PKG_ADD: autoload ("pp_stat", "instrument-control.oct");
-DEFUN_DLD (pp_stat, args, nargout, "")
+DEFUN_DLD (pp_stat, args, nargout, 
+"-*- texinfo -*-\n\
+@deftypefn {Loadable Function} {@var{stat} = } pp_stat (@var{parallel})\n \
+\n\
+Reads the Status lines.\n \
+\n\
+@var{parallel} - instance of @var{octave_parallel} class.@*\
+\n\
+The pp_stat() shall return current Status lines state as the result @var{stat}.\n \
+@end deftypefn")
 {
     if (args.length() != 1 || args(0).type_id() != octave_parallel::static_type_id())
     {

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.