changeset 11591:1d13679b587e

Use @nospell macro on certain words in docstrings.
author Rik <octave@nomad.inbox5.com>
date Thu, 20 Jan 2011 19:33:32 -0800
parents 4ced6b90fffb
children ab61de78833e
files doc/ChangeLog doc/interpreter/doccheck/README doc/interpreter/doccheck/aspell-octave.en.pws doc/interpreter/plot.txi scripts/ChangeLog scripts/image/imread.m scripts/image/imwrite.m scripts/signal/periodogram.m scripts/strings/isstrprop.m src/ChangeLog src/DLD-FUNCTIONS/str2double.cc src/data.cc src/mappers.cc src/variables.cc
diffstat 14 files changed, 50 insertions(+), 31 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,9 @@
+2011-01-20  Rik  <octave@nomad.inbox5.com>
+
+	* doc/interpreter/doccheck/aspell-octave.en.pws,
+	doc/interpreter/plot.txi: Use @nospell macro on certain words in
+	docstring.
+
 2011-01-20  John W. Eaton  <jwe@octave.org>
 
 	* faq/OctaveFAQ.texi, interpreter/doccheck/aspell-octave.en.pws,
--- a/doc/interpreter/doccheck/README
+++ b/doc/interpreter/doccheck/README
@@ -48,7 +48,10 @@
 vi misspellings
 ....
   Review misspellings and identify where to correct the source (.m, .cc, .txi)
-  The original source file is marked with a comment: '@c SRC_DIR/SRC_FILE'
+  The original source file is marked with a comment: 
+
+  @c FUNCTION_NAME SRC_DIR/SRC_FILE
+
   When there is no source file comment, the source file is the .txi source.
   Make corrections to source files, *not* arith.texi which is derived.
 ....
@@ -79,11 +82,13 @@
 
 To be added
 
-UNDOCUMENTED:
+UNDOCUMENTED FUNCTIONS:
 
-From the doc/interpreter/ directory, type 'doccheck/mk_undocumented_list'.
-This will produce a list of undocumented functions on stdout.  
+From the doc/interpreter/ directory, type 'make undocumented_list'.
+This will produce the undocumented_list file with the undocumented functions.  
 
 Functions which don't require an @DOCSTRING reference can be added to the list
-of exceptions at the bottom of the mk_undocumented_list script.
+of exceptions at the bottom of the mk_undocumented_list script.  This is often
+necessary where a single DOCSTRING, such as besselj, is used to document
+multiple functions.
 
--- a/doc/interpreter/doccheck/aspell-octave.en.pws
+++ b/doc/interpreter/doccheck/aspell-octave.en.pws
@@ -37,6 +37,9 @@
 autoregressions
 autoscaled
 AWK
+backend
+Backends
+backends
 bartlett
 Bateman
 BDF
@@ -196,7 +199,6 @@
 dx
 dy
 EastOutside
-eE
 EIDORS
 eigenpairs
 eigenvector
@@ -238,7 +240,6 @@
 exppdf
 exprnd
 extendedtext
-fA
 facecolor
 facevertexcdata
 fcdf
@@ -259,6 +260,7 @@
 FIRfilter
 FIXME
 FlashPix
+FLTK
 fltk
 fontconfig
 fontname
@@ -397,11 +399,9 @@
 Jacobian
 Jacobians
 ji
-jp
 jpeg
 JPEG
 jpg
-jpx
 keybindings
 keypress
 Kolmogorov
@@ -527,8 +527,6 @@
 multibyte
 multiline
 mxArray
-MxN
-MxNx
 myclass
 nabla
 NaN
@@ -574,7 +572,6 @@
 octaverc
 ODEPACK
 OLS
-onesided
 online
 OpenGL
 oplus
@@ -596,6 +593,7 @@
 pchip
 pcr
 pcre
+PCRE
 PCX
 pcx
 PDF
@@ -818,6 +816,7 @@
 terminal's
 tex
 Texinfo
+texinfo
 th
 ths
 tif
@@ -831,6 +830,8 @@
 TolF
 TolFun
 TolX
+toolkits
+Toolkits
 tp
 tpdf
 traceback
@@ -841,7 +842,6 @@
 trnd
 Tsang
 tuples
-twosided
 Tx
 txi
 typedefs
@@ -936,7 +936,6 @@
 xGTSV
 xl
 xmin
-xN
 xPBTRF
 xPOTRF
 xPTSV
--- a/doc/interpreter/plot.txi
+++ b/doc/interpreter/plot.txi
@@ -38,7 +38,7 @@
 @ref{Graphics Toolkits}.)
 
 The function call @code{graphics_toolkit ("fltk")} selects the
-fltk/OpenGL system, and @code{graphics_toolkit ("gnuplot")} selects the
+FLTK/OpenGL system, and @code{graphics_toolkit ("gnuplot")} selects the
 gnuplot system.  The two systems may be used selectively through the use
 of the @code{graphics_toolkit} property of the graphics handle for each
 figure.  This is explained in @ref{Graphics Data Structures}.
--- a/scripts/ChangeLog
+++ b/scripts/ChangeLog
@@ -1,3 +1,8 @@
+2011-01-20  Rik  <octave@nomad.inbox5.com>
+
+	* image/imread.m, image/imwrite.m, signal/periodogram.m,
+	strings/isstrprop.m: Use @nospell macro on certain words in docstring.
+
 2011-01-20  John W. Eaton  <jwe@octave.org>
 
 	* @ftp/loadobj.m, @ftp/saveobj.m, audio/record.m,
@@ -256,7 +261,6 @@
 
 2011-01-19  Rik  <octave@nomad.inbox5.com>
 
-
 	* general/curl.m, general/divergence.m, io/strread.m,
 	miscellaneous/mkoctfile.m, plot/bar.m, plot/errorbar.m, plot/hist.m,
 	plot/mesh.m, plot/surf.m, polynomial/polyaffine.m: Correct spelling
--- a/scripts/image/imread.m
+++ b/scripts/image/imread.m
@@ -26,8 +26,8 @@
 ##
 ## The size and numeric class of the output depends on the
 ## format of the image.  A color image is returned as an
-## MxNx3 matrix.  Gray-level and black-and-white images are
-## of size MxN.
+## @nospell{MxNx3} matrix.  Gray-level and black-and-white images are
+## of size @nospell{MxN}.
 ## The color depth of the image determines the numeric
 ## class of the output: "uint8" or "uint16" for gray
 ## and color, and "logical" for black and white.
--- a/scripts/image/imwrite.m
+++ b/scripts/image/imwrite.m
@@ -57,7 +57,7 @@
 ## @multitable @columnfractions .33 .66
 ## @headitem Extension @tab Format
 ## @item hdf @tab Hierarchical Data Format V4
-## @item jp2 and jpx @tab Joint Photographic Experts Group 2000
+## @item @nospell{jp2} and jpx @tab Joint Photographic Experts Group 2000
 ## @end multitable
 ##
 ## @seealso{imread, imfinfo}
--- a/scripts/signal/periodogram.m
+++ b/scripts/signal/periodogram.m
@@ -34,7 +34,7 @@
 ##
 ## @itemize
 ## @item x: data; if real-valued a one-sided spectrum is estimated,
-## if complex-valued or range indicates "twosided", the full spectrum is estimated.
+## if complex-valued or range indicates "@nospell{twosided}", the full spectrum is estimated.
 ##
 ## @item win: weight data with window, x.*win is used for further computation,
 ## if window is empty, a rectangular window is used.
@@ -43,8 +43,8 @@
 ##
 ## @item Fs: sampling rate, default 1.
 ##
-## @item range: "onesided" computes spectrum from [0..nfft/2+1].
-## "twosided" computes spectrum from [0..nfft-1]. These strings can appear at any
+## @item range: "@nospell{onesided}" computes spectrum from [0..nfft/2+1].
+## "@nospell{twosided}" computes spectrum from [0..nfft-1]. These strings can appear at any
 ##  position in the list input arguments after window.
 ##
 ## @item Pxx: one-, or two-sided power spectrum.
--- a/scripts/strings/isstrprop.m
+++ b/scripts/strings/isstrprop.m
@@ -52,7 +52,7 @@
 ## True for decimal digits (0-9).
 ##
 ## @item "xdigit"
-## True for hexadecimal digits (a-fA-F0-9).
+## True for hexadecimal digits (@nospell{a-fA-F0-9}).
 ##
 ## @item "space"
 ## @itemx "wspace"
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2011-01-20  Rik  <octave@nomad.inbox5.com>
+
+	* src/DLD-FUNCTIONS/str2double.cc, src/data.cc, src/mappers.cc,
+	src/variables.cc: Use @nospell macro on certain words in docstring.
+
 2011-01-20  John W. Eaton  <jwe@octave.org>
 
 	* DLD-FUNCTIONS/__delaunayn__.cc,
--- a/src/DLD-FUNCTIONS/str2double.cc
+++ b/src/DLD-FUNCTIONS/str2double.cc
@@ -234,8 +234,8 @@
 @item i*b + a\n\
 @end itemize\n\
 \n\
-If present, a and/or b are of the form [+-]d[,.]d[[eE][+-]d] where the\n\
-brackets indicate optional arguments and 'd' indicates zero or more\n\
+If present, a and/or b are of the form @nospell{[+-]d[,.]d[[eE][+-]d]} where\n\
+the brackets indicate optional arguments and 'd' indicates zero or more\n\
 digits.  The special input values @code{Inf}, @code{NaN}, and @code{NA} are\n\
 also accepted.\n\
 \n\
--- a/src/data.cc
+++ b/src/data.cc
@@ -2952,9 +2952,9 @@
   "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} ismatrix (@var{a})\n\
 Return true if @var{a} is a numeric, logical, or character matrix.\n\
-Scalars (1x1 matrices) and vectors (1xN or Nx1 matrices) are subsets\n\
-of the more general N-dimensional matrix and @code{ismatrix} will return\n\
-true for these objects as well.\n\
+Scalars (1x1 matrices) and vectors (@nospell{1xN} or @nospell{Nx1} matrices)\n\
+are subsets of the more general N-dimensional matrix and @code{ismatrix}\n\
+will return true for these objects as well.\n\
 @seealso{isscalar, isvector, iscell, isstruct, issparse}\n\
 @end deftypefn")
 {
--- a/src/mappers.cc
+++ b/src/mappers.cc
@@ -1283,7 +1283,7 @@
     "-*- texinfo -*-\n\
 @deftypefn {Mapping Function} {} isxdigit (@var{s})\n\
 Return a logical array which is true where the elements of @var{s} are\n\
-hexadecimal digits (0-9 and a-fA-F).\n\
+hexadecimal digits (0-9 and @nospell{a-fA-F}).\n\
 @seealso{isdigit}\n\
 @end deftypefn")
 {
--- a/src/variables.cc
+++ b/src/variables.cc
@@ -1811,8 +1811,8 @@
 The name of the variable.\n\
 \n\
 @item Size\n\
-The logical size of the variable.  A scalar is 1x1, a vector is 1xN or Nx1,\n\
-a 2-D matrix is MxN.\n\
+The logical size of the variable.  A scalar is 1x1, a vector is\n\
+@nospell{1xN} or @nospell{Nx1}, a 2-D matrix is @nospell{MxN}.\n\
 \n\
 @item Bytes\n\
 The amount of memory currently used to store the variable.\n\