Mercurial > octave-nkf
changeset 15007:8f0e3c5bfa5f
doc: Periodic grammarcheck of documentation
* fileattrib.m, glpk.m, axis.m, copyobj.m, gco.m, hdl2struct.m, struct2hdl.m,
eigs.cc, variables.cc: Periodic grammarcheck of documentation
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 24 Jul 2012 09:34:51 -0700 |
| parents | d8acad691f26 |
| children | ff9a638a5555 |
| files | scripts/miscellaneous/fileattrib.m scripts/optimization/glpk.m scripts/plot/axis.m scripts/plot/copyobj.m scripts/plot/gco.m scripts/plot/hdl2struct.m scripts/plot/struct2hdl.m src/DLD-FUNCTIONS/eigs.cc src/variables.cc |
| diffstat | 9 files changed, 22 insertions(+), 14 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/miscellaneous/fileattrib.m Tue Jul 24 07:50:42 2012 -0700 +++ b/scripts/miscellaneous/fileattrib.m Tue Jul 24 09:34:51 2012 -0700 @@ -57,6 +57,7 @@ ## True if the user (group; other users) has execute permission for ## @var{file}. ## @end table +## ## If an attribute does not apply (i.e., archive on a Unix system) then ## the field is set to NaN. ##
--- a/scripts/optimization/glpk.m Tue Jul 24 07:50:42 2012 -0700 +++ b/scripts/optimization/glpk.m Tue Jul 24 09:34:51 2012 -0700 @@ -369,6 +369,7 @@ ## @item 185 (@w{@code{LPX_UNDEF}}) ## Solution status is undefined. ## @end table +## ## Interior Point Method: ## ## @table @asis @@ -378,6 +379,7 @@ ## @item 151 (@w{@code{LPX_T_OPT}}) ## The interior point method is optimal. ## @end table +## ## Mixed Integer Method: ## ## @table @asis @@ -393,6 +395,7 @@ ## @item 173 (@w{@code{LPX_I_NOFEAS}}) ## No integer feasible solution. ## @end table +## ## @noindent ## If an error occurs, @var{status} will contain one of the following ## codes:
--- a/scripts/plot/axis.m Tue Jul 24 07:50:42 2012 -0700 +++ b/scripts/plot/axis.m Tue Jul 24 09:34:51 2012 -0700 @@ -109,6 +109,7 @@ ## @item "nolabel" ## Turn tic labels off for all axes. ## @end table +## ## Note, if there are no tic marks for an axis, there can be no labels. ## ## @noindent
--- a/scripts/plot/copyobj.m Tue Jul 24 07:50:42 2012 -0700 +++ b/scripts/plot/copyobj.m Tue Jul 24 09:34:51 2012 -0700 @@ -15,12 +15,12 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{hnew} =} copyobj (@var{horig}) -## @deftypefnx {Function File} {@var{hnew} =} copyobj (@var{horig}, @var{hparent}) -## Constructs a copy of the object associated with handle @var{horig} -## and returns a handle, @var{hnew}, to the new object. -## If a parent handle @var{hparent} (root, figure, axes or hggroup) is specified, -## the copied object will be created as a child to @var{hparent}. +## @deftypefn {Function File} {@var{hnew} =} copyobj (@var{horig}) +## @deftypefnx {Function File} {@var{hnew} =} copyobj (@var{horig}, @var{hparent}) +## Construct a copy of the object associated with handle @var{horig} +## and return a handle @var{hnew} to the new object. +## If a parent handle @var{hparent} (root, figure, axes, or hggroup) is +## specified, the copied object will be created as a child to @var{hparent}. ## @seealso{findobj, get, set, struct2hdl, hdl2struct} ## @end deftypefn
--- a/scripts/plot/gco.m Tue Jul 24 07:50:42 2012 -0700 +++ b/scripts/plot/gco.m Tue Jul 24 09:34:51 2012 -0700 @@ -20,8 +20,8 @@ ## @deftypefn {Function File} {@var{h} =} gco () ## @deftypefnx {Function File} {@var{h} =} gco (@var{fig}) ## Return a handle to the current object of the current figure, or a handle -## to the current object of the figure with handle @var{fig}. The current -## object of a figure is the object that was last clicked on. It is stored +## to the current object of the figure with handle @var{fig}. The current +## object of a figure is the object that was last clicked on. It is stored ## in the CurrentObject property of the target figure. ## ## If the last mouse click didn't occur on any child object of the figure, @@ -31,7 +31,7 @@ ## empty matrix. ## ## Note that the value returned by this function is not necessarily the same -## as the one returned by gcbo during callback execution. An executing +## as the one returned by gcbo during callback execution. An executing ## callback can be interrupted by another callback and the current object ## can be modified. ##
--- a/scripts/plot/hdl2struct.m Tue Jul 24 07:50:42 2012 -0700 +++ b/scripts/plot/hdl2struct.m Tue Jul 24 09:34:51 2012 -0700 @@ -15,8 +15,8 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {@var{s} =} hdl2struct (@var{h}) -## Returns a structure, @var{s}, whose fields describe the properties +## @deftypefn {Function File} {@var{s} =} hdl2struct (@var{h}) +## Return a structure, @var{s}, whose fields describe the properties ## of the object, and its children, associated with the handle, @var{h}. ## The fields of the structure, @var{s}, are "type", "handle", "properties", ## "children" and "special".
--- a/scripts/plot/struct2hdl.m Tue Jul 24 07:50:42 2012 -0700 +++ b/scripts/plot/struct2hdl.m Tue Jul 24 09:34:51 2012 -0700 @@ -18,7 +18,7 @@ ## @deftypefn {Function File} {@var{h} =} struct2hdl (@var{s}) ## @deftypefnx {Function File} {@var{h} =} struct2hdl (@var{s}, @var{p}) ## @deftypefnx {Function File} {@var{h} =} struct2hdl (@var{s}, @var{p}, @var{hilev}) -## Constructs an object from the structure @var{s}. The structure must +## Construct an object from the structure @var{s}. The structure must ## contain the fields "handle", "type", "children", "properties", and ## "special". If the handle of an existing figure or axes is specified, ## @var{p}, the new object will be created as a child to that object. @@ -27,8 +27,8 @@ ## the root figure. ## ## A third boolean argument @var{hilev} can be passed to specify wether -## the function should try to preserve listeners/calbacks e.g for -## legends or hggroups. Default is false. +## the function should try to preserve listeners/calbacks e.g., for +## legends or hggroups. Default is false. ## @seealso{findobj, get, hdl2struct, set} ## @end deftypefn
--- a/src/DLD-FUNCTIONS/eigs.cc Tue Jul 24 07:50:42 2012 -0700 +++ b/src/DLD-FUNCTIONS/eigs.cc Tue Jul 24 09:34:51 2012 -0700 @@ -258,6 +258,7 @@ default is @code{1:@var{n}}.\n\ \n\ @end table\n\ +\n\ It is also possible to represent @var{A} by a function denoted @var{af}.\n\ @var{af} must be followed by a scalar argument @var{n} defining the length\n\ of the vector argument accepted by @var{af}. @var{af} can be\n\
--- a/src/variables.cc Tue Jul 24 07:50:42 2012 -0700 +++ b/src/variables.cc Tue Jul 24 09:34:51 2012 -0700 @@ -548,6 +548,7 @@ @item \"dir\"\n\ Check only for directories.\n\ @end table\n\ +\n\ @seealso{file_in_loadpath}\n\ @end deftypefn") { @@ -2324,6 +2325,7 @@ The arguments are treated as regular expressions as any variables that\n\ match will be cleared.\n\ @end table\n\ +\n\ With the exception of @code{exclusive}, all long options can be used\n\ without the dash as well.\n\ @end deftypefn")