Mercurial > octave-nkf

comparison libinterp/corefcn/help.cc @ 17281:bc924baa2c4e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add new @qcode macro for code samples which are quoted. Macro handles options ("on") or properties ("position") more elegantly than @code{"text"}. * doc/interpreter/macros.texi: Add new @qcode macro. * doc/interpreter/tips.txi: Add documentation about @qcode macro. * doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/grammar.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/io.txi, doc/interpreter/matrix.txi, doc/interpreter/numbers.txi, doc/interpreter/oop.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/quad.txi, doc/interpreter/sparse.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m, scripts/general/dblquad.m, scripts/general/display.m, scripts/general/genvarname.m, scripts/general/idivide.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m, scripts/general/profexplore.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/triplequad.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m, scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/javaclasspath.m, scripts/java/usejava.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m, scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m, scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m, scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m, scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m, scripts/plot/plot.m, scripts/plot/print.m, scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m, scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m, scripts/polynomial/conv.m, scripts/polynomial/polyout.m, scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m, scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/periodogram.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m, scripts/specfun/legendre.m, scripts/special-matrix/gallery.m, scripts/statistics/base/mean.m, scripts/statistics/base/moment.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m, scripts/strings/index.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/validatestring.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m, scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m, scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m, scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m, scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author Rik <rik@octave.org>
date Mon, 19 Aug 2013 20:46:38 -0700
parents ee1d19174316
children 56404cdcb723
comparison
equal deleted inserted replaced
17280:1a5407bae739 17281:bc924baa2c4e
1064 DEFUN (get_help_text, args, , "-*- texinfo -*-\n\ 1064 DEFUN (get_help_text, args, , "-*- texinfo -*-\n\
1065 @deftypefn {Built-in Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\ 1065 @deftypefn {Built-in Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\
1066 Return the raw help text of function @var{name}.\n\ 1066 Return the raw help text of function @var{name}.\n\
1067 \n\ 1067 \n\
1068 The raw help text is returned in @var{text} and the format in @var{format}\n\ 1068 The raw help text is returned in @var{text} and the format in @var{format}\n\
1069 The format is a string which is one of @t{\"texinfo\"}, @t{\"html\"}, or\n\ 1069 The format is a string which is one of @qcode{\"texinfo\"},\n\
1070 @t{\"plain text\"}.\n\ 1070 @qcode{\"html\"}, or @qcode{\"plain text\"}.\n\
1071 @end deftypefn") 1071 @end deftypefn")
1072 { 1072 {
1073 octave_value_list retval; 1073 octave_value_list retval;
1074 1074
1075 if (args.length () == 1) 1075 if (args.length () == 1)
1133 "-*- texinfo -*-\n\ 1133 "-*- texinfo -*-\n\
1134 @deftypefn {Built-in Function} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname})\n\ 1134 @deftypefn {Built-in Function} {[@var{text}, @var{format}] =} get_help_text_from_file (@var{fname})\n\
1135 Return the raw help text from the file @var{fname}.\n\ 1135 Return the raw help text from the file @var{fname}.\n\
1136 \n\ 1136 \n\
1137 The raw help text is returned in @var{text} and the format in @var{format}\n\ 1137 The raw help text is returned in @var{text} and the format in @var{format}\n\
1138 The format is a string which is one of @t{\"texinfo\"}, @t{\"html\"}, or\n\ 1138 The format is a string which is one of @qcode{\"texinfo\"},\n\
1139 @t{\"plain text\"}.\n\ 1139 @qcode{\"html\"}, or @qcode{\"plain text\"}.\n\
1140 @end deftypefn") 1140 @end deftypefn")
1141 { 1141 {
1142 octave_value_list retval; 1142 octave_value_list retval;
1143 1143
1144 if (args.length () == 1) 1144 if (args.length () == 1)
1396 and @var{version} is the Octave version number.\n\ 1396 and @var{version} is the Octave version number.\n\
1397 The default value may be overridden by the environment variable\n\ 1397 The default value may be overridden by the environment variable\n\
1398 @w{@env{OCTAVE_DOC_CACHE_FILE}}, or the command line argument\n\ 1398 @w{@env{OCTAVE_DOC_CACHE_FILE}}, or the command line argument\n\
1399 @samp{--doc-cache-file FNAME}.\n\ 1399 @samp{--doc-cache-file FNAME}.\n\
1400 \n\ 1400 \n\
1401 When called from inside a function with the \"local\" option, the variable is\n\ 1401 When called from inside a function with the @qcode{\"local\"} option, the\n\
1402 changed locally for the function and any subroutines it calls. The original\n\ 1402 variable is changed locally for the function and any subroutines it calls. \n\
1403 variable value is restored when exiting the function.\n\ 1403 The original variable value is restored when exiting the function.\n\
1404 @seealso{doc_cache_create, lookfor, info_program, doc, help, makeinfo_program}\n\ 1404 @seealso{doc_cache_create, lookfor, info_program, doc, help, makeinfo_program}\n\
1405 @end deftypefn") 1405 @end deftypefn")
1406 { 1406 {
1407 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (doc_cache_file); 1407 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (doc_cache_file);
1408 } 1408 }
1420 and @var{version} is the Octave version number.\n\ 1420 and @var{version} is the Octave version number.\n\
1421 The default value may be overridden by the environment variable\n\ 1421 The default value may be overridden by the environment variable\n\
1422 @w{@env{OCTAVE_TEXI_MACROS_FILE}}, or the command line argument\n\ 1422 @w{@env{OCTAVE_TEXI_MACROS_FILE}}, or the command line argument\n\
1423 @samp{--texi-macros-file FNAME}.\n\ 1423 @samp{--texi-macros-file FNAME}.\n\
1424 \n\ 1424 \n\
1425 When called from inside a function with the \"local\" option, the variable is\n\ 1425 When called from inside a function with the @qcode{\"local\"} option, the\n\
1426 changed locally for the function and any subroutines it calls. The original\n\ 1426 variable is changed locally for the function and any subroutines it calls. \n\
1427 variable value is restored when exiting the function.\n\ 1427 The original variable value is restored when exiting the function.\n\
1428 @seealso{makeinfo_program}\n\ 1428 @seealso{makeinfo_program}\n\
1429 @end deftypefn") 1429 @end deftypefn")
1430 { 1430 {
1431 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (texi_macros_file); 1431 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (texi_macros_file);
1432 } 1432 }
1442 which @var{octave-home} is the root directory of the Octave installation.\n\ 1442 which @var{octave-home} is the root directory of the Octave installation.\n\
1443 The default value may be overridden by the environment variable\n\ 1443 The default value may be overridden by the environment variable\n\
1444 @w{@env{OCTAVE_INFO_FILE}}, or the command line argument\n\ 1444 @w{@env{OCTAVE_INFO_FILE}}, or the command line argument\n\
1445 @samp{--info-file FNAME}.\n\ 1445 @samp{--info-file FNAME}.\n\
1446 \n\ 1446 \n\
1447 When called from inside a function with the \"local\" option, the variable is\n\ 1447 When called from inside a function with the @qcode{\"local\"} option, the\n\
1448 changed locally for the function and any subroutines it calls. The original\n\ 1448 variable is changed locally for the function and any subroutines it calls. \n\
1449 variable value is restored when exiting the function.\n\ 1449 The original variable value is restored when exiting the function.\n\
1450 @seealso{info_program, doc, help, makeinfo_program}\n\ 1450 @seealso{info_program, doc, help, makeinfo_program}\n\
1451 @end deftypefn") 1451 @end deftypefn")
1452 { 1452 {
1453 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_file); 1453 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_file);
1454 } 1454 }
1466 is the system type (for example, @code{i686-pc-linux-gnu}). The\n\ 1466 is the system type (for example, @code{i686-pc-linux-gnu}). The\n\
1467 default value may be overridden by the environment variable\n\ 1467 default value may be overridden by the environment variable\n\
1468 @w{@env{OCTAVE_INFO_PROGRAM}}, or the command line argument\n\ 1468 @w{@env{OCTAVE_INFO_PROGRAM}}, or the command line argument\n\
1469 @samp{--info-program NAME}.\n\ 1469 @samp{--info-program NAME}.\n\
1470 \n\ 1470 \n\
1471 When called from inside a function with the \"local\" option, the variable is\n\ 1471 When called from inside a function with the @qcode{\"local\"} option, the\n\
1472 changed locally for the function and any subroutines it calls. The original\n\ 1472 variable is changed locally for the function and any subroutines it calls. \n\
1473 variable value is restored when exiting the function.\n\ 1473 The original variable value is restored when exiting the function.\n\
1474 @seealso{info_file, doc, help, makeinfo_program}\n\ 1474 @seealso{info_file, doc, help, makeinfo_program}\n\
1475 @end deftypefn") 1475 @end deftypefn")
1476 { 1476 {
1477 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_program); 1477 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_program);
1478 } 1478 }
1484 @deftypefnx {Built-in Function} {} makeinfo_program (@var{new_val}, \"local\")\n\ 1484 @deftypefnx {Built-in Function} {} makeinfo_program (@var{new_val}, \"local\")\n\
1485 Query or set the internal variable that specifies the name of the\n\ 1485 Query or set the internal variable that specifies the name of the\n\
1486 program that Octave runs to format help text containing\n\ 1486 program that Octave runs to format help text containing\n\
1487 Texinfo markup commands. The default value is @code{makeinfo}.\n\ 1487 Texinfo markup commands. The default value is @code{makeinfo}.\n\
1488 \n\ 1488 \n\
1489 When called from inside a function with the \"local\" option, the variable is\n\ 1489 When called from inside a function with the @qcode{\"local\"} option, the\n\
1490 changed locally for the function and any subroutines it calls. The original\n\ 1490 variable is changed locally for the function and any subroutines it calls. \n\
1491 variable value is restored when exiting the function.\n\ 1491 The original variable value is restored when exiting the function.\n\
1492 @seealso{texi_macros_file, info_file, info_program, doc, help}\n\ 1492 @seealso{texi_macros_file, info_file, info_program, doc, help}\n\
1493 @end deftypefn") 1493 @end deftypefn")
1494 { 1494 {
1495 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program); 1495 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program);
1496 } 1496 }
1502 @deftypefnx {Built-in Function} {} suppress_verbose_help_message (@var{new_val}, \"local\")\n\ 1502 @deftypefnx {Built-in Function} {} suppress_verbose_help_message (@var{new_val}, \"local\")\n\
1503 Query or set the internal variable that controls whether Octave\n\ 1503 Query or set the internal variable that controls whether Octave\n\
1504 will add additional help information to the end of the output from\n\ 1504 will add additional help information to the end of the output from\n\
1505 the @code{help} command and usage messages for built-in commands.\n\ 1505 the @code{help} command and usage messages for built-in commands.\n\
1506 \n\ 1506 \n\
1507 When called from inside a function with the \"local\" option, the variable is\n\ 1507 When called from inside a function with the @qcode{\"local\"} option, the\n\
1508 changed locally for the function and any subroutines it calls. The original\n\ 1508 variable is changed locally for the function and any subroutines it calls. \n\
1509 variable value is restored when exiting the function.\n\ 1509 The original variable value is restored when exiting the function.\n\
1510 @end deftypefn") 1510 @end deftypefn")
1511 { 1511 {
1512 return SET_INTERNAL_VARIABLE (suppress_verbose_help_message); 1512 return SET_INTERNAL_VARIABLE (suppress_verbose_help_message);
1513 } 1513 }