changeset 20466:f02c22f71cdb stable

doc: Add info about single letter codes for fread, fopen IEEE format. * file-io.cc (Fread, Fopen): Document single letter codes for "native" (n), "ieee-le" (l), and "ieee-be" (b).
author Rik <rik@octave.org>
date Thu, 06 Aug 2015 21:39:49 -0700
parents 6947b9c82d4b
children 8fcbb55745ef
files libinterp/corefcn/file-io.cc
diffstat 1 files changed, 8 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/file-io.cc	Wed Aug 05 10:48:26 2015 -0700
+++ b/libinterp/corefcn/file-io.cc	Thu Aug 06 21:39:49 2015 -0700
@@ -668,19 +668,19 @@
 The parameter @var{arch} is a string specifying the default data format\n\
 for the file.  Valid values for @var{arch} are:\n\
 \n\
-@table @samp\n\
-@item native (default)\n\
+@table @asis\n\
+@item @qcode{\"native\"} or @qcode{\"n\"} (default)\n\
 The format of the current machine.\n\
 \n\
-@item ieee-be\n\
+@item @qcode{\"ieee-be\"} or @qcode{\"b\"}\n\
 IEEE big endian format.\n\
 \n\
-@item ieee-le\n\
+@item @qcode{\"ieee-le\"} or @qcode{\"l\"}\n\
 IEEE little endian format.\n\
 @end table\n\
 \n\
 @noindent\n\
-however, conversions are currently only supported for @samp{native}\n\
+However, conversions are currently only supported for @samp{native},\n\
 @samp{ieee-be}, and @samp{ieee-le} formats.\n\
 \n\
 When opening a new file that does not yet exist, permissions will be set to\n\
@@ -1599,13 +1599,13 @@
 for the file.  Valid values are\n\
 \n\
 @table @asis\n\
-@item @qcode{\"native\"}\n\
+@item @qcode{\"native\"} or @qcode{\"n\"}\n\
 The format of the current machine.\n\
 \n\
-@item @qcode{\"ieee-be\"}\n\
+@item @qcode{\"ieee-be\"} or @qcode{\"b\"}\n\
 IEEE big endian.\n\
 \n\
-@item @qcode{\"ieee-le\"}\n\
+@item @qcode{\"ieee-le\"} or @qcode{\"l\"}\n\
 IEEE little endian.\n\
 @end table\n\
 \n\