Mercurial > hg > octave-max
changeset 14623:36f451642f79
doc: Add texi_macros_file to manual.
* basics.txi: Add function to manual.
* aspell-octave.en.pws: Add 'makeinfo' to Octave dictionary.
* help.cc (makeinfo_program, texi_macros_file): Improve doctrings.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Thu, 10 May 2012 17:08:50 -0700 |
| parents | 8ffb01c3a27a |
| children | be12c85c6ce7 |
| files | doc/interpreter/basics.txi doc/interpreter/doccheck/aspell-octave.en.pws src/help.cc |
| diffstat | 3 files changed, 6 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/basics.txi +++ b/doc/interpreter/basics.txi @@ -389,6 +389,8 @@ @DOCSTRING(makeinfo_program) +@DOCSTRING(texi_macros_file) + @DOCSTRING(doc_cache_file) @DOCSTRING(suppress_verbose_help_message)
--- a/doc/interpreter/doccheck/aspell-octave.en.pws +++ b/doc/interpreter/doccheck/aspell-octave.en.pws @@ -534,6 +534,7 @@ Mahalanobis makefile makefiles +makeinfo Mandriva MANOVA manova
--- a/src/help.cc +++ b/src/help.cc @@ -1302,7 +1302,7 @@ @deftypefnx {Built-in Function} {@var{old_val} =} texi_macros_file (@var{new_val})\n\ @deftypefnx {Built-in Function} {} texi_macros_file (@var{new_val}, \"local\")\n\ Query or set the internal variable that specifies the name of the\n\ -file containing Texinfo macros that are prepended to doc strings\n\ +file containing Texinfo macros that are prepended to documentation strings\n\ before they are passed to makeinfo. The default value is \n\ @file{@var{octave-home}/share/octave/@var{version}/etc/macros.texi},\n\ in which @var{octave-home} is the root directory of the Octave installation,\n\ @@ -1314,7 +1314,7 @@ When called from inside a function with the \"local\" option, the variable is\n\ changed locally for the function and any subroutines it calls. The original\n\ variable value is restored when exiting the function.\n\ -@seealso{lookfor, info_program, doc, help, makeinfo_program}\n\ +@seealso{makeinfo_program}\n\ @end deftypefn") { return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (texi_macros_file); @@ -1378,7 +1378,7 @@ When called from inside a function with the \"local\" option, the variable is\n\ changed locally for the function and any subroutines it calls. The original\n\ variable value is restored when exiting the function.\n\ -@seealso{info_file, info_program, doc, help}\n\ +@seealso{texi_macros_file, info_file, info_program, doc, help}\n\ @end deftypefn") { return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program);