Menu
▾
▴
[Octave-cvsupdate] SF.net SVN: octave:[9916] trunk/octave-forge
|
From: <car...@us...> - 2012-03-16 03:58:10
|
Revision: 9916
http://octave.svn.sourceforge.net/octave/?rev=9916&view=rev
Author: carandraug
Date: 2012-03-16 03:58:03 +0000 (Fri, 16 Mar 2012)
Log Message:
-----------
help text: functions in oct files are {Loadable Functions}, not {Function Files}. Fixing help texts accordingly
Modified Paths:
--------------
trunk/octave-forge/extra/ocs/src/Mshichmanhodgesmosfet.cc
trunk/octave-forge/main/fits/src/read_fits_image.cc
trunk/octave-forge/main/fits/src/save_fits_image.cc
trunk/octave-forge/main/fits/src/save_fits_image_multi_ext.cc
trunk/octave-forge/main/image/src/__boundary__.cc
trunk/octave-forge/main/image/src/__bwdist.cc
trunk/octave-forge/main/image/src/bwfill.cc
trunk/octave-forge/main/image/src/bwlabel.cc
trunk/octave-forge/main/image/src/bwlabeln.cc
trunk/octave-forge/main/image/src/graycomatrix.cc
trunk/octave-forge/main/image/src/nonmax_supress.cc
trunk/octave-forge/main/image/src/rotate_scale.cc
trunk/octave-forge/main/io/src/cell2csv.cc
trunk/octave-forge/main/io/src/csv2cell.cc
trunk/octave-forge/main/io/src/csvconcat.cc
trunk/octave-forge/main/io/src/csvexplode.cc
trunk/octave-forge/main/io/src/xmlread.cc
trunk/octave-forge/main/miscellaneous/src/text_waitbar.cc
trunk/octave-forge/main/odepkg/src/odepkg_octsolver_rodas.cc
trunk/octave-forge/main/strings/src/pcregexp.cc
Modified: trunk/octave-forge/extra/ocs/src/Mshichmanhodgesmosfet.cc
===================================================================
--- trunk/octave-forge/extra/ocs/src/Mshichmanhodgesmosfet.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/extra/ocs/src/Mshichmanhodgesmosfet.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -222,7 +222,7 @@
DEFUN_DLD(Mshichmanhodgesmosfet,args,nargout,
"-*- texinfo -*-\n\
\n\
-@deftypefn{Function File} @\n\
+@deftypefn{Loadable Function} @\n\
{[@var{a},@var{b},@var{c}]=} Mshichmanhodgesmosfet@\n\
(@var{string}, @var{parameters}, @var{parameternames}, @\n\
@var{extvar},@var{intvar},@var{t})\n\
Modified: trunk/octave-forge/main/fits/src/read_fits_image.cc
===================================================================
--- trunk/octave-forge/main/fits/src/read_fits_image.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/fits/src/read_fits_image.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -19,7 +19,7 @@
DEFUN_DLD( read_fits_image, args, nargout,
"-*- texinfo -*-\n\
-@deftypefn {Function File} {[@var{image},@var{header}]} = read_fits_image(@var{filename},@var{hdu})\n\
+@deftypefn {Loadable Function} {[@var{image},@var{header}]} = read_fits_image(@var{filename},@var{hdu})\n\
Read FITS file @var{filename} and return image data in @var{image}, and the image header in @var{header}.\n\
\n\
@var{filename} can be concatenated with filters provided by libcfitsio. See:\
Modified: trunk/octave-forge/main/fits/src/save_fits_image.cc
===================================================================
--- trunk/octave-forge/main/fits/src/save_fits_image.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/fits/src/save_fits_image.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -11,7 +11,7 @@
DEFUN_DLD( save_fits_image, args, nargout,
"-*- texinfo -*-\n\
- @deftypefn {Function File} save_fits_image(@var{filename}, @var{image}, @var{bit_per_pixel})\n\
+ @deftypefn {Loadable Function} save_fits_image(@var{filename}, @var{image}, @var{bit_per_pixel})\n\
Write @var{IMAGE} to FITS file @var{filename}.\n\n\
Datacubes will be saved with NAXIS=3.\n\n\
The optional parameter @var{bit_per_pixel} specifies the data type of the pixel values. Accepted string values are BYTE_IMG, SHORT_IMG, LONG_IMG, LONGLONG_IMG, FLOAT_IMG, and DOUBLE_IMG (default). Alternatively, corresponding numbers may be passed, i.e. 8, 16, 32, 64, -32, and -64.\n\n\
Modified: trunk/octave-forge/main/fits/src/save_fits_image_multi_ext.cc
===================================================================
--- trunk/octave-forge/main/fits/src/save_fits_image_multi_ext.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/fits/src/save_fits_image_multi_ext.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -11,7 +11,7 @@
DEFUN_DLD( save_fits_image_multi_ext, args, nargout,
"-*- texinfo -*-\n\
- @deftypefn {Function File} save_fits_image_multi_ext(@var{filename}, @var{image}, @var{bit_per_pixel})\n\
+ @deftypefn {Loadable Function} save_fits_image_multi_ext(@var{filename}, @var{image}, @var{bit_per_pixel})\n\
Write @var{IMAGE} to FITS file @var{filename}.\n\n\
Datacubes will be saved as multi-image extensions.\n\n\
The optional parameter @var{bit_per_pixel} specifies the data type of the pixel values. Accepted string values are BYTE_IMG, SHORT_IMG, LONG_IMG, LONGLONG_IMG, FLOAT_IMG, and DOUBLE_IMG (default). Alternatively, corresponding numbers may be passed, i.e. 8, 16, 32, 64, -32, and -64.\n\n\
Modified: trunk/octave-forge/main/image/src/__boundary__.cc
===================================================================
--- trunk/octave-forge/main/image/src/__boundary__.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/image/src/__boundary__.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -27,8 +27,8 @@
DEFUN_DLD(__boundary__, args, nargout,
"-*- texinfo -*-\n\
-@deftypefn {Function File} {@var{b} = } boundary(@var{region})\n\
-@deftypefnx {Function File} {@var{b} = } boundary(@var{region}, @var{conn})\n\
+@deftypefn {Loadable Function} {@var{b} = } boundary(@var{region})\n\
+@deftypefnx {Loadable Function} {@var{b} = } boundary(@var{region}, @var{conn})\n\
Trace the boundary of an object in a binary image.\n\
\n\
@code{boundary} computes the exterior clockwise boundary of the single \
Modified: trunk/octave-forge/main/image/src/__bwdist.cc
===================================================================
--- trunk/octave-forge/main/image/src/__bwdist.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/image/src/__bwdist.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -64,7 +64,7 @@
DEFUN_DLD ( __bwdist, args, nargout,
"-*- texinfo -*-\n\
-@deftypefn {Function File} {@var{D} =} __bwdist(@var{bw})\n\
+@deftypefn {Loadable Function} {@var{D} =} __bwdist(@var{bw})\n\
Computes the distance transform of the image @var{bw}.\n\
@var{bw} should be a binary 2D array, either a Boolean array or a\n\
numeric array containing only the values 0 and 1.\n\
@@ -75,7 +75,7 @@
metric) to the closest object pixel. For each object pixel the\n\
return value is 0.\n\
\n\
-@deftypefnx{Function File} {@var{D} =} __bwdist(@var{bw}, @var{method})\n\
+@deftypefnx{Loadable Function} {@var{D} =} __bwdist(@var{bw}, @var{method})\n\
\n\
@var{method} is a string to choose the distance metric. Currently\n\
available metrics are 'euclidean', 'chessboard', 'cityblock' and\n\
@@ -83,7 +83,7 @@
to any string starting with 'e', 'ch', 'ci' and 'q', respectively.\n\
If @var{method} is not specified, 'euclidean' is the default.\n\
\n\
-@deftypefnx {Function File} {[@var{D},@var{C}] =} __bwdist(@var{bw}, @var{method})\n\
+@deftypefnx {Loadable Function} {[@var{D},@var{C}] =} __bwdist(@var{bw}, @var{method})\n\
\n\
If a second output argument is given, the linear index for the\n\
closest object pixel is returned for each pixel. (For object\n\
Modified: trunk/octave-forge/main/image/src/bwfill.cc
===================================================================
--- trunk/octave-forge/main/image/src/bwfill.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/image/src/bwfill.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -25,7 +25,7 @@
DEFUN_DLD (bwfill, args, ,"\
-*- texinfo -*-\n\
-@deftypefn {Function File} {[@var{bw2}, @var{idx}] =} bwfill(@var{bw1}, @var{c}, @var{r}, @var{n})\n\
+@deftypefn {Loadable Function} {[@var{bw2}, @var{idx}] =} bwfill(@var{bw1}, @var{c}, @var{r}, @var{n})\n\
Perform a flood-fill operation on the binary image @var{bw1}.\n\
The flood-filling starts in the pixel (@var{r}, @var{c}). If @var{r} and @var{c}\n\
are vectors of the same length, each pixel pair (@var{r}(i), @var{c}(i)) will\n\
@@ -35,7 +35,7 @@
\n\
The output is the processed image @var{bw2} and the indexes of the filled\n\
pixels @var{idx}\n\
-@deftypefnx{Function File} {[@var{bw2}, @var{idx}] =} bwfill(@var{bw1}, \"holes\", @var{n})\n\
+@deftypefnx{Loadable Function} {[@var{bw2}, @var{idx}] =} bwfill(@var{bw1}, \"holes\", @var{n})\n\
If the string \"holes\" is given instead of starting points for the flood-fill\n\
operation, the function finds interior holes in @var{bw1} and fills them.\n\
@end deftypefn\n\
Modified: trunk/octave-forge/main/image/src/bwlabel.cc
===================================================================
--- trunk/octave-forge/main/image/src/bwlabel.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/image/src/bwlabel.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -61,7 +61,7 @@
DEFUN_DLD(bwlabel, args, , "\
-*- texinfo -*-\n\
-@deftypefn {Function File} {[@var{l}, @var{num}] =} bwlabel(@var{bw}, @var{n})\n\
+@deftypefn {Loadable Function} {[@var{l}, @var{num}] =} bwlabel(@var{bw}, @var{n})\n\
Labels foreground objects in the binary image @var{bw}.\n\
The output @var{l} is a matrix where 0 indicates a background pixel,\n\
1 indicates that the pixel belong to object number 1, 2 that the pixel\n\
Modified: trunk/octave-forge/main/image/src/bwlabeln.cc
===================================================================
--- trunk/octave-forge/main/image/src/bwlabeln.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/image/src/bwlabeln.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -214,7 +214,7 @@
DEFUN_DLD(bwlabeln, args, , "\
-*- texinfo -*-\n\
-@deftypefn {Function File} {[@var{l}, @var{num}] =} bwlabeln(@var{bw}, @var{n})\n\
+@deftypefn {Loadable Function} {[@var{l}, @var{num}] =} bwlabeln(@var{bw}, @var{n})\n\
Label foreground objects in the n-dimensional binary image @var{bw}.\n\
\n\
The optional argument @var{n} sets the connectivity and defaults 26.\n\
Modified: trunk/octave-forge/main/image/src/graycomatrix.cc
===================================================================
--- trunk/octave-forge/main/image/src/graycomatrix.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/image/src/graycomatrix.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -26,7 +26,7 @@
DEFUN_DLD(graycomatrix, args, , "\
-*- texinfo -*-\n\
-@deftypefn {Function File} {@var{P} =} graycomatrix(@var{im}, @var{levels}, @var{distances}, @var{angles})\n\
+@deftypefn {Loadable Function} {@var{P} =} graycomatrix(@var{im}, @var{levels}, @var{distances}, @var{angles})\n\
Calculates the gray-level co-occurrence matrix @var{P} of a gray-level image @var{im}.\n\
\n\
@var{P} is a 4-dimensional matrix (histogram). The value @var{P}(@var{i},@var{j},@var{d},@var{theta})\n\
Modified: trunk/octave-forge/main/image/src/nonmax_supress.cc
===================================================================
--- trunk/octave-forge/main/image/src/nonmax_supress.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/image/src/nonmax_supress.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -47,13 +47,13 @@
DEFUN_DLD(nonmax_supress,args,nargout,"\
-*- texinfo -*-\n\
-@deftypefn {Function File} nonmax_supress (@var{Es}, @var{Eo})\n\
+@deftypefn {Loadable Function} nonmax_supress (@var{Es}, @var{Eo})\n\
Performs non-maximum supression on the given edge data. \
@var{Es} is a matrix containing the edge strength (the length of \
the gradient), and @var{Eo} is the edge normal orientation (the \
direction of the gradient).\n\
\n\
-@deftypefnx {Function File} nonmax_supress (@var{Es}, @var{Eo},\
+@deftypefnx {Loadable Function} nonmax_supress (@var{Es}, @var{Eo},\
@var{low}, @var{high} )\n\
Performs non-maximum supression and hysteresis thresholdong, using \
@var{low} and @var{high} as thresholds.\n\
Modified: trunk/octave-forge/main/image/src/rotate_scale.cc
===================================================================
--- trunk/octave-forge/main/image/src/rotate_scale.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/image/src/rotate_scale.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -31,7 +31,7 @@
DEFUN_DLD (rotate_scale, args, , "\
-*- texinfo -*-\n\
-@deftypefn {Function File} {@var{im1} =} rotate_scale(@var{im0}, @var{lm0}, @var{lm1}, @var{out_size})\n\
+@deftypefn {Loadable Function} {@var{im1} =} rotate_scale(@var{im0}, @var{lm0}, @var{lm1}, @var{out_size})\n\
Arbitrary rotation and scaling of a gray-scale image using fast bilinear interpolation.\n\
\n\
The image @var{im0} will be rotated and scaled such that the landmark points in\n\
Modified: trunk/octave-forge/main/io/src/cell2csv.cc
===================================================================
--- trunk/octave-forge/main/io/src/cell2csv.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/io/src/cell2csv.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -20,9 +20,9 @@
DEFUN_DLD (cell2csv, args, nargout,
"-*- texinfo -*-\n"
- "@deftypefn {Function File} {} cell2csv (@var{file}, @var{c})\n"
- "@deftypefnx {Function File} {} cell2csv (@var{file}, @var{c}, @var{sep})\n"
- "@deftypefnx {Function File} {} cell2csv (@var{file}, @var{c}, @var{sep}, @var{prot})\n"
+ "@deftypefn {Loadable Function} {} cell2csv (@var{file}, @var{c})\n"
+ "@deftypefnx {Loadable Function} {} cell2csv (@var{file}, @var{c}, @var{sep})\n"
+ "@deftypefnx {Loadable Function} {} cell2csv (@var{file}, @var{c}, @var{sep}, @var{prot})\n"
"\n"
"Create a CSV file from a cell. "
"@var{sep} changes the character used to separate two fields. By "
Modified: trunk/octave-forge/main/io/src/csv2cell.cc
===================================================================
--- trunk/octave-forge/main/io/src/csv2cell.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/io/src/csv2cell.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -22,9 +22,9 @@
DEFUN_DLD (csv2cell, args, nargout,
"-*- texinfo -*-\n"
- "@deftypefn {Function File} {@var{c} = } csv2cell (@var{file})\n"
- "@deftypefnx {Function File} {@var{c} = } csv2cell (@var{file}, @var{sep})\n"
- "@deftypefnx {Function File} {@var{c} = } csv2cell (@var{file}, @var{sep}, @var{prot})\n"
+ "@deftypefn {Loadable Function} {@var{c} = } csv2cell (@var{file})\n"
+ "@deftypefnx {Loadable Function} {@var{c} = } csv2cell (@var{file}, @var{sep})\n"
+ "@deftypefnx {Loadable Function} {@var{c} = } csv2cell (@var{file}, @var{sep}, @var{prot})\n"
"\n"
"Read a CSV (Comma Separated Values) file and convert it into a "
"cell. "
Modified: trunk/octave-forge/main/io/src/csvconcat.cc
===================================================================
--- trunk/octave-forge/main/io/src/csvconcat.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/io/src/csvconcat.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -18,9 +18,9 @@
DEFUN_DLD (csvconcat, args, nargout,
"-*- texinfo -*-\n"
- "@deftypefn {Function File} {@var{str} = } csvconcat (@var{c})\n"
- "@deftypefnx {Function File} {@var{str} = } csvconcat (@var{c}, @var{sep})\n"
- "@deftypefnx {Function File} {@var{str} = } csvconcat (@var{c}, @var{sep}, @var{prot})\n"
+ "@deftypefn {Loadable Function} {@var{str} = } csvconcat (@var{c})\n"
+ "@deftypefnx {Loadable Function} {@var{str} = } csvconcat (@var{c}, @var{sep})\n"
+ "@deftypefnx {Loadable Function} {@var{str} = } csvconcat (@var{c}, @var{sep}, @var{prot})\n"
"\n"
"Concatenate a cell into a CSV string or array of strings. "
"@var{sep} changes the character used to separate two fields. By "
Modified: trunk/octave-forge/main/io/src/csvexplode.cc
===================================================================
--- trunk/octave-forge/main/io/src/csvexplode.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/io/src/csvexplode.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -18,9 +18,9 @@
DEFUN_DLD (csvexplode, args, nargout,
"-*- texinfo -*-\n"
- "@deftypefn {Function File} {@var{c} = } csvexplode (@var{str})\n"
- "@deftypefnx {Function File} {@var{c} = } csvexplode (@var{str}, @var{sep})\n"
- "@deftypefnx {Function File} {@var{c} = } csvexplode (@var{str}, @var{sep}, @var{prot})\n"
+ "@deftypefn {Loadable Function} {@var{c} = } csvexplode (@var{str})\n"
+ "@deftypefnx {Loadable Function} {@var{c} = } csvexplode (@var{str}, @var{sep})\n"
+ "@deftypefnx {Loadable Function} {@var{c} = } csvexplode (@var{str}, @var{sep}, @var{prot})\n"
"\n"
"Explode a CSV string into a cell. "
"@var{sep} changes the character used to separate two fields. By "
Modified: trunk/octave-forge/main/io/src/xmlread.cc
===================================================================
--- trunk/octave-forge/main/io/src/xmlread.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/io/src/xmlread.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -127,7 +127,7 @@
DEFUN_DLD (xmlread, args, nargout,
"-*- texinfo -*-\n"
- "@deftypefn {Function File} {@var{value}} xmlread(@var{filename})\n"
+ "@deftypefn {Loadable Function} {@var{value}} xmlread(@var{filename})\n"
"\n"
"Read a @var{value} from @var{filename} as an XML file\n"
"@end deftypefn") {
Modified: trunk/octave-forge/main/miscellaneous/src/text_waitbar.cc
===================================================================
--- trunk/octave-forge/main/miscellaneous/src/text_waitbar.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/miscellaneous/src/text_waitbar.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -36,9 +36,9 @@
DEFUN_DLD(text_waitbar, args, nargout,
" -*- texinfo -*-\n\
-@deftypefn {Function File} {} text_waitbar (@var{frac})\n\
-@deftypefnx {Function File} {} text_waitbar (@var{frac}, @var{msg})\n\
-@deftypefnx {Function File} {} text_waitbar (0, @var{n})\n\
+@deftypefn {Loadable Function} {} text_waitbar (@var{frac})\n\
+@deftypefnx {Loadable Function} {} text_waitbar (@var{frac}, @var{msg})\n\
+@deftypefnx {Loadable Function} {} text_waitbar (0, @var{n})\n\
Display text-based waitbar/progress bar.\n\
\n\
This function is similar to the @code{waitbar} function but is a text, rather\n\
Modified: trunk/octave-forge/main/odepkg/src/odepkg_octsolver_rodas.cc
===================================================================
--- trunk/octave-forge/main/odepkg/src/odepkg_octsolver_rodas.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/odepkg/src/odepkg_octsolver_rodas.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -461,7 +461,7 @@
// PKG_ADD: autoload ("oders", "dldsolver.oct");
DEFUN_DLD (oders, args, nargout,
"-*- texinfo -*-\n\
-@deftypefn {Function File} {[@var{}] =} oders (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}])\n\
+@deftypefn {Loadable Function} {[@var{}] =} oders (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}])\n\
@deftypefnx {Command} {[@var{sol}] =} oders (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}])\n\
@deftypefnx {Command} {[@var{t}, @var{y}, [@var{xe}, @var{ye}, @var{ie}]] =} oders (@var{@@fun}, @var{slot}, @var{init}, [@var{opt}], [@var{par1}, @var{par2}, @dots{}])\n\
\n\
Modified: trunk/octave-forge/main/strings/src/pcregexp.cc
===================================================================
--- trunk/octave-forge/main/strings/src/pcregexp.cc 2012-03-16 03:18:23 UTC (rev 9915)
+++ trunk/octave-forge/main/strings/src/pcregexp.cc 2012-03-16 03:58:03 UTC (rev 9916)
@@ -29,7 +29,7 @@
//FIXME This function needs some documentation
DEFUN_DLD(pcregexp, args, nargout, "\
-*- texinfo -*-\n\
-@deftypefn {Function File} {[@ldots{}] =} pcregexp (@ldots{})\n\
+@deftypefn {Loadable Function} {[@ldots{}] =} pcregexp (@ldots{})\n\
Perl-compatible regular expression matching.\n\
\n\
Check your system's @code{pcre} man page.\n\
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
