Mercurial > hg > octave-lyh

comparison scripts/miscellaneous/doc.m @ 6615:687ae48b2253

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[project @ 2007-05-13 06:24:57 by jwe]
author jwe
date Sun, 13 May 2007 06:24:58 +0000
parents 860682863572
children 93c65f2a5668
comparison
equal deleted inserted replaced
6614:3a53d0f3e0e4 6615:687ae48b2253
15 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 15 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16 ## 02110-1301, USA. 16 ## 02110-1301, USA.
17 17
18 ## -*- texinfo -*- 18 ## -*- texinfo -*-
19 ## @deftypefn {Command} doc @var{function_name} 19 ## @deftypefn {Command} doc @var{function_name}
20 ## Displays documentation for the function @var{function_name}. 20 ## Display documentation for the function @var{function_name}
21 ## For example, if you want to see the documentation for the Octave 21 ## directly from an on-line version of
22 ## random number generator @code{rand}, type 22 ## the printed manual, using the GNU Info browser. If invoked without
23 ## @example 23 ## any arguments, the manual is shown from the beginning.
24 ## @code{doc rand} 24 ##
25 ## @end example 25 ## For example, the command @kbd{doc rand} starts the GNU Info browser
26 ## at this node in the on-line version of the manual.
27 ##
28 ## Once the GNU Info browser is running, help for using it is available
29 ## using the command @kbd{C-h}.
26 ## @seealso{help} 30 ## @seealso{help}
27 ## @end deftypefn 31 ## @end deftypefn
28 32
29 ## Author: Soren Hauberg <soren@hauberg.org> 33 ## Author: Soren Hauberg <soren@hauberg.org>
30 ## Adapted-by: jwe 34 ## Adapted-by: jwe