Mercurial > octave-nkf

changeset 20213:2ae4a7ef4378 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Clean up several deftypefn entries of Command type. * dirfns.cc (Fcd): Add parentheses to function calling form. * input.cc (Fecho): List each Command calling form. * variables.cc (Fwhos): Use "Built-in Function" for functional calling form. * box.m: List no argument form first. * hidden.m: Remove quotes from "on"/"off" arguments to command.
author Rik <rik@octave.org>
date Mon, 11 May 2015 22:13:08 -0700
parents 4951982f8a2c
children cc5ffacb15ab
files libinterp/corefcn/dirfns.cc libinterp/corefcn/input.cc libinterp/corefcn/variables.cc scripts/plot/appearance/box.m scripts/plot/appearance/hidden.m
diffstat 5 files changed, 11 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/dirfns.cc	Mon May 11 22:08:26 2015 -0700
+++ b/libinterp/corefcn/dirfns.cc	Mon May 11 22:13:08 2015 -0700
@@ -96,7 +96,7 @@
        "-*- texinfo -*-\n\
 @deftypefn  {Command} {} cd @var{dir}\n\
 @deftypefnx {Command} {} cd\n\
-@deftypefnx {Built-in Function} {@var{old_dir} =} cd @var{dir}\n\
+@deftypefnx {Built-in Function} {@var{old_dir} =} cd (@var{dir})\n\
 @deftypefnx {Command} {} chdir @dots{}\n\
 Change the current working directory to @var{dir}.\n\
 \n\
--- a/libinterp/corefcn/input.cc	Mon May 11 22:08:26 2015 -0700
+++ b/libinterp/corefcn/input.cc	Mon May 11 22:13:08 2015 -0700
@@ -941,7 +941,11 @@
 
 DEFUN (echo, args, ,
        "-*- texinfo -*-\n\
-@deftypefn {Command} {} echo options\n\
+@deftypefn  {Command} {} echo\n\
+@deftypefnx {Command} {} echo on\n\
+@deftypefnx {Command} {} echo off\n\
+@deftypefnx {Command} {} echo on all\n\
+@deftypefnx {Command} {} echo off all\n\
 Control whether commands are displayed as they are executed.\n\
 \n\
 Valid options are:\n\
--- a/libinterp/corefcn/variables.cc	Mon May 11 22:08:26 2015 -0700
+++ b/libinterp/corefcn/variables.cc	Mon May 11 22:13:08 2015 -0700
@@ -1898,7 +1898,7 @@
 @deftypefn  {Command} {} whos\n\
 @deftypefnx {Command} {} whos pattern @dots{}\n\
 @deftypefnx {Command} {} whos option pattern @dots{}\n\
-@deftypefnx {Command} {S =} whos (\"pattern\", @dots{})\n\
+@deftypefnx {Built-in Function} {S =} whos (\"pattern\", @dots{})\n\
 Provide detailed information on currently defined variables matching the\n\
 given patterns.\n\
 \n\
--- a/scripts/plot/appearance/box.m	Mon May 11 22:08:26 2015 -0700
+++ b/scripts/plot/appearance/box.m	Mon May 11 22:13:08 2015 -0700
@@ -17,9 +17,9 @@
 ## <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn  {Command} {} box on
+## @deftypefn  {Command} {} box
+## @deftypefnx {Command} {} box on
 ## @deftypefnx {Command} {} box off
-## @deftypefnx {Command} {} box
 ## @deftypefnx {Function File} {} box (@var{hax}, @dots{})
 ## Control display of the axis border.
 ##
--- a/scripts/plot/appearance/hidden.m	Mon May 11 22:08:26 2015 -0700
+++ b/scripts/plot/appearance/hidden.m	Mon May 11 22:13:08 2015 -0700
@@ -18,8 +18,8 @@
 
 ## -*- texinfo -*-
 ## @deftypefn  {Command} {} hidden
-## @deftypefnx {Command} {} hidden "on"
-## @deftypefnx {Command} {} hidden "off"
+## @deftypefnx {Command} {} hidden on
+## @deftypefnx {Command} {} hidden off
 ## @deftypefnx {Function File} {@var{mode} =} hidden (@dots{})
 ## Control mesh hidden line removal.
 ##