changeset 833:eb027eb95855

doc: small fixes for Texinfo syntax
author Carnë Draug <carandraug@octave.org>
date Tue, 12 Nov 2013 01:28:19 +0000
parents 9ea56b150093
children aba385baeb96
files inst/bestblk.m inst/imbothat.m inst/imclose.m inst/imopen.m inst/imtophat.m inst/mmgradm.m inst/nlfilter.m
diffstat 7 files changed, 10 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/inst/bestblk.m
+++ b/inst/bestblk.m
@@ -14,8 +14,8 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn  {Function File} {@var{blk_siz} =} bestblk (@var{IMS})
-## @deftypefnx {Function File} {@var{blk_siz} =} bestblk (@var{IMS}, @var{max})
+## @deftypefn  {Function File} {@var{blk_size} =} bestblk (@var{IMS})
+## @deftypefnx {Function File} {@var{blk_size} =} bestblk (@var{IMS}, @var{max})
 ## @deftypefnx {Function File} {[@var{Mb}, @var{Nb}, @dots{}] =} bestblk (@dots{})
 ## Calculate block best size for block processing.
 ##
@@ -23,11 +23,11 @@
 ## blocks @var{blk_size}, that minimize padding and is smaller than or equal to
 ## @var{k} (defaults to 100) 
 ##
-## The output @var{blk_siz] is a row vector for the block size.  If there are
+## The output @var{blk_size} is a row vector for the block size.  If there are
 ## multiple output arguments, the number of rows is assigned to the first
 ## (@var{Mb}), and the number of columns to the second (@var{Nb}), etc.
 ##
-## To determine @var{block_size}, the following is performed for each
+## To determine @var{blk_size}, the following is performed for each
 ## dimension:
 ##
 ## @enumerate
--- a/inst/imbothat.m
+++ b/inst/imbothat.m
@@ -23,7 +23,7 @@
 ## @item
 ## strel object;
 ## @item
-## array of strel objects as returned by `@strel/getsequence';
+## array of strel objects as returned by `@@strel/getsequence';
 ## @item
 ## matrix of 0's and 1's.
 ## @end itemize
--- a/inst/imclose.m
+++ b/inst/imclose.m
@@ -22,7 +22,7 @@
 ## @item
 ## strel object;
 ## @item
-## array of strel objects as returned by `@strel/getsequence';
+## array of strel objects as returned by `@@strel/getsequence';
 ## @item
 ## matrix of 0's and 1's.
 ## @end itemize
--- a/inst/imopen.m
+++ b/inst/imopen.m
@@ -22,7 +22,7 @@
 ## @item
 ## strel object;
 ## @item
-## array of strel objects as returned by `@strel/getsequence';
+## array of strel objects as returned by `@@strel/getsequence';
 ## @item
 ## matrix of 0's and 1's.
 ## @end itemize
--- a/inst/imtophat.m
+++ b/inst/imtophat.m
@@ -23,7 +23,7 @@
 ## @item
 ## strel object;
 ## @item
-## array of strel objects as returned by `@strel/getsequence';
+## array of strel objects as returned by `@@strel/getsequence';
 ## @item
 ## matrix of 0's and 1's.
 ## @end itemize
--- a/inst/mmgradm.m
+++ b/inst/mmgradm.m
@@ -26,7 +26,7 @@
 ## @item
 ## strel object;
 ## @item
-## array of strel objects as returned by `@strel/getsequence';
+## array of strel objects as returned by `@@strel/getsequence';
 ## @item
 ## matrix of 0's and 1's.
 ## @end itemize
--- a/inst/nlfilter.m
+++ b/inst/nlfilter.m
@@ -45,7 +45,7 @@
 ## along a column to return a single value, consider using @code{colfilt}
 ## which usually performs faster.  If @var{func} makes use of the colon
 ## operator to select all elements in the block, e.g., if @var{func} looks
-## anything like @code{@(x) sum (x(:))}, it is a good indication that
+## anything like @code{@@(x) sum (x(:))}, it is a good indication that
 ## @code{colfilt} should be used.  In addition, many sliding block operations
 ## have their own specific implementations (see help text of @code{colfilt}
 ## for a list).