Mercurial > octave

comparison libinterp/corefcn/defaults.cc @ 20853:1142cf6abc0d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
2015 Code Sprint: remove class of function from docstring for all C++ files.
author Rik <rik@octave.org>
date Sat, 12 Dec 2015 07:40:03 -0800
parents 8bb38ba1bad6
children 48b2ad5ee801
comparison
equal deleted inserted replaced
20852:516bb87ea72e 20853:1142cf6abc0d
474 set_built_in_docstrings_file (); 474 set_built_in_docstrings_file ();
475 } 475 }
476 476
477 DEFUN (EDITOR, args, nargout, 477 DEFUN (EDITOR, args, nargout,
478 "-*- texinfo -*-\n\ 478 "-*- texinfo -*-\n\
479 @deftypefn {Built-in Function} {@var{val} =} EDITOR ()\n\ 479 @deftypefn {} {@var{val} =} EDITOR ()\n\
480 @deftypefnx {Built-in Function} {@var{old_val} =} EDITOR (@var{new_val})\n\ 480 @deftypefnx {} {@var{old_val} =} EDITOR (@var{new_val})\n\
481 @deftypefnx {Built-in Function} {} EDITOR (@var{new_val}, \"local\")\n\ 481 @deftypefnx {} {} EDITOR (@var{new_val}, \"local\")\n\
482 Query or set the internal variable that specifies the default text editor.\n\ 482 Query or set the internal variable that specifies the default text editor.\n\
483 \n\ 483 \n\
484 The default value is taken from the environment variable @w{@env{EDITOR}}\n\ 484 The default value is taken from the environment variable @w{@env{EDITOR}}\n\
485 when Octave starts. If the environment variable is not initialized,\n\ 485 when Octave starts. If the environment variable is not initialized,\n\
486 @w{@env{EDITOR}} will be set to @qcode{\"emacs\"}.\n\ 486 @w{@env{EDITOR}} will be set to @qcode{\"emacs\"}.\n\
507 %!error (EDITOR (1, 2)) 507 %!error (EDITOR (1, 2))
508 */ 508 */
509 509
510 DEFUN (EXEC_PATH, args, nargout, 510 DEFUN (EXEC_PATH, args, nargout,
511 "-*- texinfo -*-\n\ 511 "-*- texinfo -*-\n\
512 @deftypefn {Built-in Function} {@var{val} =} EXEC_PATH ()\n\ 512 @deftypefn {} {@var{val} =} EXEC_PATH ()\n\
513 @deftypefnx {Built-in Function} {@var{old_val} =} EXEC_PATH (@var{new_val})\n\ 513 @deftypefnx {} {@var{old_val} =} EXEC_PATH (@var{new_val})\n\
514 @deftypefnx {Built-in Function} {} EXEC_PATH (@var{new_val}, \"local\")\n\ 514 @deftypefnx {} {} EXEC_PATH (@var{new_val}, \"local\")\n\
515 Query or set the internal variable that specifies a colon separated\n\ 515 Query or set the internal variable that specifies a colon separated\n\
516 list of directories to append to the shell PATH when executing external\n\ 516 list of directories to append to the shell PATH when executing external\n\
517 programs.\n\ 517 programs.\n\
518 \n\ 518 \n\
519 The initial value of is taken from the environment variable\n\ 519 The initial value of is taken from the environment variable\n\
547 %!error (EXEC_PATH (1, 2)) 547 %!error (EXEC_PATH (1, 2))
548 */ 548 */
549 549
550 DEFUN (IMAGE_PATH, args, nargout, 550 DEFUN (IMAGE_PATH, args, nargout,
551 "-*- texinfo -*-\n\ 551 "-*- texinfo -*-\n\
552 @deftypefn {Built-in Function} {@var{val} =} IMAGE_PATH ()\n\ 552 @deftypefn {} {@var{val} =} IMAGE_PATH ()\n\
553 @deftypefnx {Built-in Function} {@var{old_val} =} IMAGE_PATH (@var{new_val})\n\ 553 @deftypefnx {} {@var{old_val} =} IMAGE_PATH (@var{new_val})\n\
554 @deftypefnx {Built-in Function} {} IMAGE_PATH (@var{new_val}, \"local\")\n\ 554 @deftypefnx {} {} IMAGE_PATH (@var{new_val}, \"local\")\n\
555 Query or set the internal variable that specifies a colon separated\n\ 555 Query or set the internal variable that specifies a colon separated\n\
556 list of directories in which to search for image files.\n\ 556 list of directories in which to search for image files.\n\
557 \n\ 557 \n\
558 When called from inside a function with the @qcode{\"local\"} option, the\n\ 558 When called from inside a function with the @qcode{\"local\"} option, the\n\
559 variable is changed locally for the function and any subroutines it calls.\n\ 559 variable is changed locally for the function and any subroutines it calls.\n\
577 %!error (IMAGE_PATH (1, 2)) 577 %!error (IMAGE_PATH (1, 2))
578 */ 578 */
579 579
580 DEFUN (OCTAVE_HOME, args, , 580 DEFUN (OCTAVE_HOME, args, ,
581 "-*- texinfo -*-\n\ 581 "-*- texinfo -*-\n\
582 @deftypefn {Built-in Function} {} OCTAVE_HOME ()\n\ 582 @deftypefn {} {} OCTAVE_HOME ()\n\
583 Return the name of the top-level Octave installation directory.\n\ 583 Return the name of the top-level Octave installation directory.\n\
584 @seealso{EXEC_PATH, IMAGE_PATH}\n\ 584 @seealso{EXEC_PATH, IMAGE_PATH}\n\
585 @end deftypefn") 585 @end deftypefn")
586 { 586 {
587 if (args.length () != 0) 587 if (args.length () != 0)
595 %!error OCTAVE_HOME (1) 595 %!error OCTAVE_HOME (1)
596 */ 596 */
597 597
598 DEFUNX ("OCTAVE_VERSION", FOCTAVE_VERSION, args, , 598 DEFUNX ("OCTAVE_VERSION", FOCTAVE_VERSION, args, ,
599 "-*- texinfo -*-\n\ 599 "-*- texinfo -*-\n\
600 @deftypefn {Built-in Function} {} OCTAVE_VERSION ()\n\ 600 @deftypefn {} {} OCTAVE_VERSION ()\n\
601 Return the version number of Octave as a string.\n\ 601 Return the version number of Octave as a string.\n\
602 @seealso{ver, version}\n\ 602 @seealso{ver, version}\n\
603 @end deftypefn") 603 @end deftypefn")
604 { 604 {
605 if (args.length () != 0) 605 if (args.length () != 0)