octave-nkf: scripts/help/doc.m annotate

annotate scripts/help/doc.m @ 18891:7bbe3658c5ef

maint: Use "FIXME:" coding convention in m-files. * flipdim.m, prepad.m, rotdim.m, doc.m, strread.m, textread.m, krylov.m, colon.m, dump_prefs.m, fileattrib.m, getappdata.m, __xzip__.m, unpack.m, fsolve.m, axis.m, meshc.m, print.m, __ghostscript__.m, __go_draw_axes__.m, __print_parse_opts__.m, struct2hdl.m, unique.m, spstats.m, treeplot.m, test.m, datestr.m: Use "FIXME:" coding convention in m-files.

author	Rik <rik@octave.org>
date	Wed, 25 Jun 2014 13:45:41 -0700
parents	ab775508dff9
children	e433efa383e4

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 17516 diff changeset	1 ## Copyright (C) 2005-2013 Søren Hauberg
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11547 diff changeset	2 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	3 ## This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	4 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	13 ## General Public License for more details.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	14 ##
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6615 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	18
62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	20 ## @deftypefn {Command} {} doc @var{function_name}
6615 687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6344 diff changeset	21 ## Display documentation for the function @var{function_name}
15544 6a4e79110857 doc: Replace 'on-line' with modern 'online' in documentation and messages. Rik <rik@octave.org> parents: 15466 diff changeset	22 ## directly from an online version of
6615 687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6344 diff changeset	23 ## the printed manual, using the GNU Info browser. If invoked without
687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6344 diff changeset	24 ## any arguments, the manual is shown from the beginning.
687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6344 diff changeset	25 ##
687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6344 diff changeset	26 ## For example, the command @kbd{doc rand} starts the GNU Info browser
15544 6a4e79110857 doc: Replace 'on-line' with modern 'online' in documentation and messages. Rik <rik@octave.org> parents: 15466 diff changeset	27 ## at the @code{rand} node in the online version of the manual.
6615 687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6344 diff changeset	28 ##
687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6344 diff changeset	29 ## Once the GNU Info browser is running, help for using it is available
687ae48b2253 [project @ 2007-05-13 06:24:57 by jwe] jwe parents: 6344 diff changeset	30 ## using the command @kbd{C-h}.
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	31 ## @seealso{help}
11547 e1851653d59c Eliminate @deffn macros. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	32 ## @end deftypefn
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	33
62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	34 ## Author: Soren Hauberg <soren@hauberg.org>
62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	35 ## Adapted-by: jwe
62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	36
62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	37 function retval = doc (fname)
62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	38
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	39 if (nargin == 0 \|\| nargin == 1)
0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	40
0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	41 ftype = 0;
0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	42
0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	43 if (nargin == 1)
0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	44 ## Get the directory where the function lives.
18891 7bbe3658c5ef maint: Use "FIXME:" coding convention in m-files. Rik <rik@octave.org> parents: 18190 diff changeset	45 ## FIXME: Maybe we should have a better way of doing this?
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	46
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	47 if (ischar (fname))
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9724 diff changeset	48 ftype = exist (fname);
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	49 else
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9724 diff changeset	50 error ("doc: expecting argument to be a character string");
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	51 endif
0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	52 else
0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	53 fname = "";
0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	54 endif
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	55
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17243 diff changeset	56 ## if GUI is running, let it display the function
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	57 if isguirunning ()
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	58 __octave_link_show_doc__ (fname);
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	59 else
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	60
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	61 if (ftype == 2 \|\| ftype == 3)
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	62 ffile = which (fname);
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	63 else
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	64 ffile = "";
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	65 endif
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	66
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	67 if (isempty (ffile))
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	68 info_dir = octave_config_info ("infodir");
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	69 else
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	70 info_dir = fileparts (ffile);
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	71 endif
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	72
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	73 ## Determine if a file called doc.info exist in the same
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	74 ## directory as the function.
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	75
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	76 info_file_name = fullfile (info_dir, "doc.info");
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	77
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	78 [stat_info, err] = stat (info_file_name);
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	79
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	80 if (err < 0)
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	81 info_file_name = info_file ();
17516 21656a949661 Add hook function to handle missing Octave components Mike Miller <mtmiller@ieee.org> parents: 17336 diff changeset	82
18190 ab775508dff9 doc.m: Check for existence of compressed info file (bug #41054) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	83 if (! exist (info_file_name, "file")
ab775508dff9 doc.m: Check for existence of compressed info file (bug #41054) Mike Miller <mtmiller@ieee.org> parents: 17744 diff changeset	84 && ! exist ([info_file_name ".gz"], "file"))
17516 21656a949661 Add hook function to handle missing Octave components Mike Miller <mtmiller@ieee.org> parents: 17336 diff changeset	85 __gripe_missing_component__ ("doc", "info-file");
21656a949661 Add hook function to handle missing Octave components Mike Miller <mtmiller@ieee.org> parents: 17336 diff changeset	86 endif
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	87 endif
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	88
18891 7bbe3658c5ef maint: Use "FIXME:" coding convention in m-files. Rik <rik@octave.org> parents: 18190 diff changeset	89 ## FIXME: Don't change the order of the arguments below because
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	90 ## the info-emacs-info script currently expects --directory DIR as
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	91 ## the third and fourth arguments. Someone should fix that.
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	92
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	93 cmd = sprintf ("\"%s\" --file \"%s\" --directory \"%s\"",
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	94 info_program (), info_file_name, info_dir);
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	95
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	96 have_fname = ! isempty (fname);
6017 b124a912d28b [project @ 2006-10-02 14:58:18 by jwe] jwe parents: 6016 diff changeset	97
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	98 if (have_fname)
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	99 status = system (sprintf ("%s --index-search \"%s\"", cmd, fname));
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	100 endif
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	101
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	102
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	103 if (! (have_fname && status == 0))
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	104 status = system (cmd);
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	105 if (status == 127)
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	106 warning ("unable to find info program '%s'", info_program ());
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	107 endif
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	108 endif
6344 860682863572 [project @ 2007-02-22 20:24:11 by jwe] jwe parents: 6339 diff changeset	109
17029 359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	110 if (nargout > 0)
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	111 retval = status;
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	112 endif
359c5ca795cd Display doc info pages using documentation browser when in GUI mode (Bug #39451) John Donoghue <john.donoghue@ieee.org> parents: 15545 diff changeset	113
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	114 endif
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	115 else
5830 0bb816a28335 [project @ 2006-05-26 19:04:08 by jwe] jwe parents: 5794 diff changeset	116 print_usage ();
5672 62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	117 endif
62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	118
62734ddaf17b [project @ 2006-03-15 21:27:34 by jwe] jwe parents: diff changeset	119 endfunction
8558 438520011621 Check for successful build of the documentation Thorsten Meyer <thorsten.meyier@gmx.de> parents: 7017 diff changeset	120
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	121
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	122 %!test
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	123 %! ifile = info_file ();
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	124 %! if (exist (ifile) != 2 && exist (sprintf ("%s.gz", ifile)) != 2)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	125 %! error ("Info file %s or %s.gz does not exist!", ifile, ifile);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	126 %! endif
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	127

Mercurial > octave-nkf

annotate scripts/help/doc.m @ 18891:7bbe3658c5ef