Mercurial > hg > octave-max

changeset 11567:5c18da80e28a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc fixes
author John W. Eaton <jwe@octave.org>
date Wed, 19 Jan 2011 05:38:40 -0500
parents 8bb85ba7c9a6
children de5fba8337c5
files scripts/help/help.m scripts/miscellaneous/orderfields.m scripts/plot/view.m
diffstat 3 files changed, 9 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/help/help.m
+++ b/scripts/help/help.m
@@ -18,20 +18,17 @@
 
 ## -*- texinfo -*-
 ## @deftypefn {Command} {} help @var{name}
-## @deftypefn {Command} {} help @code{--list}
-## Display the help text for @var{name}.
-## If invoked without any arguments, @code{help} display instructions
-## on how to access help from the command line.
-##
-## For example, the command @kbd{help help} prints a short message
-## describing the @code{help} command.
+## @deftypefnx {Command} {} help @code{--list}
+## Display the help text for @var{name}.   For example, the command
+## @kbd{help help} prints a short message describing the @code{help}
+## command.
 ##
 ## Given the single argument @code{--list}, list all operators,
 ## keywords, built-in functions, and loadable functions available
 ## in the current session of Octave.
 ##
-## @deftypefnx {Function File} {@var{text} =} help (@var{name})
-## Return the help text for the function, @var{name}.
+## If invoked without any arguments, @code{help} display instructions
+## on how to access help from the command line.
 ##
 ## The help command can give you information about operators, but not the
 ## comma and semicolons that are used as command separators.  To get help
--- a/scripts/miscellaneous/orderfields.m
+++ b/scripts/miscellaneous/orderfields.m
@@ -36,6 +36,7 @@
 ## Examples:
 ##
 ## @example
+## @group
 ## s = struct("d", 4, "b", 2, "a", 1, "c", 3);
 ## t1 = orderfields(s)
 ##      @result{} t1 = 
@@ -80,6 +81,7 @@
 ##         4
 ##         2
 ##         3
+## @end group
 ## @end example
 ##
 ## @seealso{getfield, rmfield, isfield, isstruct, fieldnames, struct}
--- a/scripts/plot/view.m
+++ b/scripts/plot/view.m
@@ -18,7 +18,7 @@
 
 ## -*- texinfo -*-
 ## @deftypefn  {Function File} {[@var{azimuth}, @var{elevation}] =} view ()
-## @deftypefn  {Function File} {} view (@var{azimuth}, @var{elevation})
+## @deftypefnx  {Function File} {} view (@var{azimuth}, @var{elevation})
 ## @deftypefnx {Function File} {} view ([@var{azimuth}, @var{elevation}])
 ## @deftypefnx {Function File} {} view ([@var{x}, @var{y}, @var{z}])
 ## @deftypefnx {Function File} {} view (@var{dims})