diff libinterp/corefcn/sysdep.cc @ 32488:d7a3ed7f2fdc stable

doc: grammarcheck C++ files before 9.1 release. * libinterp/corefcn/graphics.cc, libinterp/corefcn/input.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/sysdep.cc: grammarcheck C++ files before 9.1 release.
author Rik <rik@octave.org>
date Thu, 23 Nov 2023 19:42:27 -0800
parents 85255746fc21
children ca5d00ab014c
line wrap: on
line diff
--- a/libinterp/corefcn/sysdep.cc	Thu Nov 23 18:28:08 2023 -0800
+++ b/libinterp/corefcn/sysdep.cc	Thu Nov 23 19:42:27 2023 -0800
@@ -772,11 +772,9 @@
 
 DEFUN (isenv, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn {} {@var{val} =} isenv (@var{var})
-Check if the environment variable @var{var} exists.
-
-This function returns true if an environment variable with the name @var{var}
-exists.  Otherwise, it returns false.
+@deftypefn {} {@var{tf} =} isenv (@var{var})
+Return true if the variable @var{var} is an environment variable, and false
+otherwise.
 
 For example,
 
@@ -785,7 +783,8 @@
 @end example
 
 @noindent
-returns true if an environment variable with the name @qcode{"PATH"} exists.
+will typically return true on UNIX systems because @qcode{"PATH"} is an
+environment variable for UNIX.
 @seealso{getenv, setenv, unsetenv}
 @end deftypefn */)
 {
@@ -850,7 +849,8 @@
 
 DEFUN (unsetenv, args, ,
        doc: /* -*- texinfo -*-
-@deftypefn {} {@var{status} =} unsetenv (@var{var})
+@deftypefn  {} {} unsetenv ("@var{var}")
+@deftypefnx {} {@var{status} =} unsetenv ("@var{var}")
 Delete the environment variable @var{var}.
 
 Return 0 if the variable was deleted, or did not exist, and -1 if an error