# HG changeset patch
# User Rik <rik@octave.org>
# Date 1388782878 28800
# Node ID bea06b5d44233b39aa33ee0d6a5f46d43e09883e
# Parent  8c92b5e7fa4da5958d334a9b484ea69d7c92e40c
doc: Improve documentation for fread function.

* file-io.cc (Ffread): Redo docstring to include multiple calling forms and to
use @var macro around count variable.

diff -r 8c92b5e7fa4d -r bea06b5d4423 libinterp/corefcn/file-io.cc
--- a/libinterp/corefcn/file-io.cc	Fri Jan 03 15:12:30 2014 -0500
+++ b/libinterp/corefcn/file-io.cc	Fri Jan 03 13:01:18 2014 -0800
@@ -1404,9 +1404,13 @@
 
 DEFUN (fread, args, ,
        "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {[@var{val}, @var{count}] =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip}, @var{arch})\n\
-Read binary data of type @var{precision} from the specified file ID\n\
-@var{fid}.\n\
+@deftypefn  {Built-in Function} {@var{val} =} fread (@var{fid})\n\
+@deftypefnx {Built-in Function} {@var{val} =} fread (@var{fid}, @var{size})\n\
+@deftypefnx {Built-in Function} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision})\n\
+@deftypefnx {Built-in Function} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip})\n\
+@deftypefnx {Built-in Function} {@var{val} =} fread (@var{fid}, @var{size}, @var{precision}, @var{skip}, @var{arch})\n\
+@deftypefnx {Built-in Function} {[@var{val}, @var{count}] =} fread (@dots{})\n\
+Read binary data from the specified file ID @var{fid}.\n\
 \n\
 The optional argument @var{size} specifies the amount of data to read\n\
 and may be one of\n\
@@ -1559,8 +1563,8 @@
 IEEE little endian.\n\
 @end table\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\
+The output argument @var{val} contains the data read from the file.\n\
+The optional return value @var{count} contains the number of elements read.\n\
 @seealso{fwrite, fgets, fgetl, fscanf, fopen}\n\
 @end deftypefn")
 {