Mercurial > octave-nkf
comparison src/variables.cc @ 9724:f22bbc5d56e9
Fix various incorrect usages of TeXinfo deffn and deftypefn macros
which were causing bad entries in the function index.
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Tue, 13 Oct 2009 21:10:37 -0700 |
parents | bb413c0d0d6d |
children | 04386b72d3df |
comparison
equal
deleted
inserted
replaced
9723:f426899f4b9c | 9724:f22bbc5d56e9 |
---|---|
1598 return retval; | 1598 return retval; |
1599 } | 1599 } |
1600 | 1600 |
1601 DEFUN (who, args, nargout, | 1601 DEFUN (who, args, nargout, |
1602 "-*- texinfo -*-\n\ | 1602 "-*- texinfo -*-\n\ |
1603 @deffn {Command} who\n\ | 1603 @deftypefn {Command} {} who\n\ |
1604 @deffnx {Command} who pattern @dots{}\n\ | 1604 @deftypefnx {Command} {} who pattern @dots{}\n\ |
1605 @deffnx {Command} who option pattern @dots{}\n\ | 1605 @deftypefnx {Command} {} who option pattern @dots{}\n\ |
1606 @deffnx {Command} C = who(\"pattern\", @dots{})\n\ | 1606 @deftypefnx {Command} {C =} who(\"pattern\", @dots{})\n\ |
1607 List currently defined variables matching the given patterns. Valid\n\ | 1607 List currently defined variables matching the given patterns. Valid\n\ |
1608 pattern syntax is the same as described for the @code{clear} command.\n\ | 1608 pattern syntax is the same as described for the @code{clear} command.\n\ |
1609 If no patterns are supplied, all variables are listed.\n\ | 1609 If no patterns are supplied, all variables are listed.\n\ |
1610 By default, only variables visible in the local scope are displayed.\n\ | 1610 By default, only variables visible in the local scope are displayed.\n\ |
1611 \n\ | 1611 \n\ |
1625 @end table\n\ | 1625 @end table\n\ |
1626 \n\ | 1626 \n\ |
1627 If called as a function, return a cell array of defined variable names\n\ | 1627 If called as a function, return a cell array of defined variable names\n\ |
1628 matching the given patterns.\n\ | 1628 matching the given patterns.\n\ |
1629 @seealso{whos, regexp}\n\ | 1629 @seealso{whos, regexp}\n\ |
1630 @end deffn") | 1630 @end deftypefn") |
1631 { | 1631 { |
1632 octave_value retval; | 1632 octave_value retval; |
1633 | 1633 |
1634 if (nargout < 2) | 1634 if (nargout < 2) |
1635 { | 1635 { |
1646 return retval; | 1646 return retval; |
1647 } | 1647 } |
1648 | 1648 |
1649 DEFUN (whos, args, nargout, | 1649 DEFUN (whos, args, nargout, |
1650 "-*- texinfo -*-\n\ | 1650 "-*- texinfo -*-\n\ |
1651 @deffn {Command} whos\n\ | 1651 @deftypefn {Command} {} whos\n\ |
1652 @deffnx {Command} whos pattern @dots{}\n\ | 1652 @deftypefnx {Command} {} whos pattern @dots{}\n\ |
1653 @deffnx {Command} whos option pattern @dots{}\n\ | 1653 @deftypefnx {Command} {} whos option pattern @dots{}\n\ |
1654 @deffnx {Command} S = whos(\"pattern\", @dots{})\n\ | 1654 @deftypefnx {Command} {S =} whos(\"pattern\", @dots{})\n\ |
1655 Provide detailed information on currently defined variables matching the\n\ | 1655 Provide detailed information on currently defined variables matching the\n\ |
1656 given patterns. Options and pattern syntax are the same as for the\n\ | 1656 given patterns. Options and pattern syntax are the same as for the\n\ |
1657 @code{who} command. Extended information about each variable is\n\ | 1657 @code{who} command. Extended information about each variable is\n\ |
1658 summarized in a table with the following default entries.\n\ | 1658 summarized in a table with the following default entries.\n\ |
1659 \n\ | 1659 \n\ |
1686 If @code{whos} is called as a function, return a struct array of defined\n\ | 1686 If @code{whos} is called as a function, return a struct array of defined\n\ |
1687 variable names matching the given patterns. Fields in the structure\n\ | 1687 variable names matching the given patterns. Fields in the structure\n\ |
1688 describing each variable are: name, size, bytes, class, global, sparse, \n\ | 1688 describing each variable are: name, size, bytes, class, global, sparse, \n\ |
1689 complex, nesting, persistent.\n\ | 1689 complex, nesting, persistent.\n\ |
1690 @seealso{who, whos_line_format}\n\ | 1690 @seealso{who, whos_line_format}\n\ |
1691 @end deffn") | 1691 @end deftypefn") |
1692 { | 1692 { |
1693 octave_value retval; | 1693 octave_value retval; |
1694 | 1694 |
1695 if (nargout < 2) | 1695 if (nargout < 2) |
1696 { | 1696 { |