octave-nkf: src/file-io.cc comparison

comparison src/file-io.cc @ 5642:2618a0750ae6

[project @ 2006-03-06 21:26:48 by jwe]

author	jwe
date	Mon, 06 Mar 2006 21:26:54 +0000
parents	0f6947621602
children	ab9a339fcec8

comparison

equal deleted inserted replaced

-:eb998631a4aa
+:2618a0750ae6
 DEFUN (fclose, args, ,
 "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} fclose (@var{fid})\n\
 Closes the specified file.  If successful, @code{fclose} returns 0,\n\
 otherwise, it returns -1.\n\
-@end deftypefn\n\
+@seealso{fopen, fseek, ftell}\n\
-@seealso{fopen, fseek, ftell}")
+@end deftypefn")
 {
 octave_value retval = -1;
 int nargin = args.length ();
 For example, it is always a good idea to flush the standard output\n\
 stream before calling @code{input}.\n\
 \n\
 @code{fflush} returns 0 on success and an OS dependent error value\n\
 (@minus{}1 on unix) on error.\n\
-@end deftypefn\n\
+@seealso{fopen, fclose}\n\
-@seealso{fopen, fclose}")
+@end deftypefn")
 {
 octave_value retval = -1;
 int nargin = args.length ();
 \n\
 If @var{len} is omitted, @code{fgetl} reads until the next newline\n\
 character.\n\
 \n\
 If there are no more characters to read, @code{fgetl} returns @minus{}1.\n\
-@end deftypefn\n\
+@seealso{fread, fscanf}\n\
-@seealso{fread, fscanf}")
+@end deftypefn")
 {
 static std::string who = "fgetl";
 octave_value_list retval;
 \n\
 If @var{len} is omitted, @code{fgets} reads until the next newline\n\
 character.\n\
 \n\
 If there are no more characters to read, @code{fgets} returns @minus{}1.\n\
-@end deftypefn\n\
+@seealso{fread, fscanf}\n\
-@seealso{fread, fscanf}")
+@end deftypefn")
 {
 static std::string who = "fgets";
 octave_value_list retval;
 @end table\n\
 \n\
 @noindent\n\
 however, conversions are currently only supported for @samp{native}\n\
 @samp{ieee-be}, and @samp{ieee-le} formats.\n\
-@end deftypefn\n\
+@seealso{fclose, fread, fseek}\n\
-@seealso{fclose, fread, fseek}")
+@end deftypefn")
 {
 octave_value_list retval;
 retval(0) = -1.0;
 file) or strings \"cof\", \"bof\" or \"eof\". If @var{origin} is omitted,\n\
 @code{SEEK_SET} is assumed.  The offset must be zero, or a value returned\n\
 by @code{ftell} (in which case @var{origin} must be @code{SEEK_SET}).\n\
 \n\
 Return 0 on success and -1 on error.\n\
-@end deftypefn\n\
+@seealso{ftell, fopen, fclose}\n\
-@seealso{ftell, fopen, fclose}")
+@end deftypefn")
 {
 octave_value retval = -1;
 int nargin = args.length ();
 DEFUN (ftell, args, ,
 "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} ftell (@var{fid})\n\
 Return the position of the file pointer as the number of characters\n\
 from the beginning of the file @var{fid}.\n\
-@end deftypefn\n\
+@seealso{fseek, fopen, fclose}\n\
-@seealso{fseek, fopen, fclose}")
+@end deftypefn")
 {
 octave_value retval = -1;
 int nargin = args.length ();
 DEFUN (fprintf, args, nargout,
 "-*- texinfo -*-\n\
 @deftypefn {Built-in Function} {} fprintf (@var{fid}, @var{template}, @dots{})\n\
 This function is just like @code{printf}, except that the output is\n\
 written to the stream @var{fid} instead of @code{stdout}.\n\
-@end deftypefn\n\
+@seealso{printf, sprintf, fread, fscanf, fopen, fclose}\n\
-@seealso{printf, sprintf, fread, fscanf, fopen, fclose}")
+@end deftypefn")
 {
 static std::string who = "fprintf";
 octave_value retval;
 @deftypefn {Built-in Function} {} printf (@var{template}, @dots{})\n\
 Print optional arguments under the control of the template string\n\
 @var{template} to the stream @code{stdout}.\n\
 \n\
 Return the number of characters printed.\n\
-@end deftypefn\n\
+@seealso{fprintf, sprintf, scanf}\n\
-@seealso{fprintf, sprintf, scanf}")
+@end deftypefn")
 {
 static std::string who = "printf";
 octave_value retval;
 This is like @code{printf}, except that the output is returned as a\n\
 string.  Unlike the C library function, which requires you to provide a\n\
 suitably sized string as an argument, Octave's @code{sprintf} function\n\
 returns the string, automatically sized to hold all of the items\n\
 converted.\n\
-@end deftypefn\n\
+@seealso{printf, fprintf, sscanf}\n\
-@seealso{printf, fprintf, sscanf}")
+@end deftypefn")
 {
 static std::string who = "sprintf";
 octave_value_list retval;
 In the second form, read from @var{fid} according to @var{template},\n\
 with each conversion specifier in @var{template} corresponding to a\n\
 single scalar return value.  This form is more `C-like', and also\n\
 compatible with previous versions of Octave.  The number of successful\n\
 conversions is returned in @var{count}\n\
-@end deftypefn\n\
+@seealso{scanf, sscanf, fread, fprintf}\n\
-@seealso{scanf, sscanf, fread, fprintf}")
+@end deftypefn")
 {
 static std::string who = "fscanf";
 octave_value_list retval;
 @deftypefn {Built-in Function} {[@var{val}, @var{count}] =} sscanf (@var{string}, @var{template}, @var{size})\n\
 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}] = } sscanf (@var{string}, @var{template}, \"C\")\n\
 This is like @code{fscanf}, except that the characters are taken from the\n\
 string @var{string} instead of from a stream.  Reaching the end of the\n\
 string is treated as an end-of-file condition.\n\
-@end deftypefn\n\
+@seealso{fscanf, scanf, sprintf}\n\
-@seealso{fscanf, scanf, sprintf}")
+@end deftypefn")
 {
 static std::string who = "sscanf";
 octave_value_list retval;
 @deftypefnx {Built-in Function} {[@var{v1}, @var{v2}, @dots{}, @var{count}]] = } scanf (@var{template}, \"C\")\n\
 This is equivalent to calling @code{fscanf} with @var{fid} = @code{stdin}.\n\
 \n\
 It is currently not useful to call @code{scanf} in interactive\n\
 programs.\n\
-@end deftypefn\n\
+@seealso{fscanf, sscanf, printf}\n\
-@seealso{fscanf, sscanf, printf}")
+@end deftypefn")
 {
 int nargin = args.length ();
 octave_value_list tmp_args (nargin+1, octave_value ());
 Conversions are currently only supported for @code{\"ieee-be\"} and\n\
 @code{\"ieee-le\"} formats.\n\
 \n\
 The data read from the file is returned in @var{val}, and the number of\n\
 values read is returned in @code{count}\n\
-@end deftypefn\n\
+@seealso{fwrite, fopen, fclose}\n\
-@seealso{fwrite, fopen, fclose}")
+@end deftypefn")
 {
 octave_value_list retval;
 int nargin = args.length ();
 The remaining arguments @var{precision}, @var{skip}, and @var{arch} are\n\
 optional, and are interpreted as described for @code{fread}.\n\
 \n\
 The behavior of @code{fwrite} is undefined if the values in @var{data}\n\
 are too large to fit in the specified precision.\n\
-@end deftypefn\n\
+@seealso{fread, fopen, fclose}\n\
-@seealso{fread, fopen, fclose}")
+@end deftypefn")
 {
 octave_value retval = -1;
 int nargin = args.length ();
 @deftypefn {Built-in Function} {} feof (@var{fid})\n\
 Return 1 if an end-of-file condition has been encountered for a given\n\
 file and 0 otherwise.  Note that it will only return 1 if the end of the\n\
 file has already been encountered, not if the next read operation will\n\
 result in an end-of-file condition.\n\
-@end deftypefn\n\
+@seealso{fread, fopen, fclose}\n\
-@seealso{fread, fopen, fclose}")
+@end deftypefn")
 {
 octave_value retval = -1;
 int nargin = args.length ();
 If @var{dir} is also omitted, the default directory for temporary files\n\
 is used.  If @var{dir} is provided, it must exist, otherwise the default\n\
 directory for temporary files is used.  Since the named file is not\n\
 opened, by @code{tmpnam}, it is possible (though relatively unlikely)\n\
 that it will not be available by the time your program attempts to open it.\n\
-@end deftypefn\n\
+@seealso{tmpfile, mkstemp, P_tmpdir}\n\
-@seealso{tmpfile, mkstemp, P_tmpdir}")
+@end deftypefn")
 {
 octave_value retval;
 int len = args.length ();
 exits.\n\
 \n\
 If successful, @var{fid} is a valid file ID and @var{msg} is an empty\n\
 string.  Otherwise, @var{fid} is -1 and @var{msg} contains a\n\
 system-dependent error message.\n\
-@end deftypefn\n\
+@seealso{tmpnam, mkstemp, P_tmpdir}\n\
-@seealso{tmpnam, mkstemp, P_tmpdir}")
+@end deftypefn")
 {
 octave_value_list retval;
 retval(1) = std::string ();
 retval(0) = -1;
 \n\
 If successful, @var{fid} is a valid file ID, @var{name} is the name of\n\
 the file, and and @var{msg} is an empty string.  Otherwise, @var{fid}\n\
 is -1, @var{name} is empty, and @var{msg} contains a system-dependent\n\
 error message.\n\
-@end deftypefn\n\
+@seealso{tmpfile, tmpnam, P_tmpdir}\n\
-@seealso{tmpfile, tmpnam, P_tmpdir}")
+@end deftypefn")
 {
 octave_value_list retval;
 retval(2) = std::string ();
 retval(1) = std::string ();

Mercurial > octave-nkf

comparison src/file-io.cc @ 5642:2618a0750ae6