Updated cv help to include reference to named arguments
authorhbristow <hilton.bristow@gmail.com>
Fri, 30 Aug 2013 06:48:41 +0000 (16:48 +1000)
committerhbristow <hilton.bristow@gmail.com>
Fri, 30 Aug 2013 06:48:41 +0000 (16:48 +1000)
modules/matlab/generator/templates/template_map_base.m

index 7c2cc2b..a7d61b4 100644 (file)
 %     camera = cv.VideoCapture();
 %     camera.open('/path/to/file');
 %
+% You can specify optional arguments by name, similar to how python
+% and many builtin Matlab functions work. For example, the cv.dft
+% method used above has an optional 'nonzeroRows' argument. If
+% you want to specify that, but keep the default 'flags' behaviour,
+% simply call the method as:
+%
+%     Xf = cv.dft(X, 'nonzeroRows', 7);
+%
 % <strong>HELP</strong>
 % Each method has its own help file containing information about the
 % arguments, return values, and what operation the method performs.