Mercurial > octave
diff libinterp/corefcn/file-io.cc @ 25454:41ea5f665659 stable
doc: Use qcode macro to document fseek offsets (bug #51402).
* file-io.cc (Ffseek): Use @qcode macro aroud fseek offsets such as SEEK_SET so
that they do not appear in the terminal window surrounded with single quotes
('SEEK_SET') which confusingly looks like a string.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 12 Jun 2018 08:04:59 -0700 |
| parents | 6652d3823428 |
| children | 49fa88321686 |
line wrap: on
line diff
--- a/libinterp/corefcn/file-io.cc Tue Jun 12 10:24:25 2018 -0400 +++ b/libinterp/corefcn/file-io.cc Tue Jun 12 08:04:59 2018 -0700 @@ -722,10 +722,10 @@ Set the file pointer to the location @var{offset} within the file @var{fid}. The pointer is positioned @var{offset} characters from the @var{origin}, which -may be one of the predefined variables @w{@code{SEEK_SET}} (beginning), -@w{@code{SEEK_CUR}} (current position), or @w{@code{SEEK_END}} (end of file) or -strings @nospell{@qcode{"bof"}}, @nospell{@qcode{"cof"}}, or -@nospell{@qcode{"eof"}}. If @var{origin} is omitted, @w{@code{SEEK_SET}} is +may be one of the predefined variables @w{@qcode{SEEK_SET}} (beginning), +@w{@qcode{SEEK_CUR}} (current position), or @w{@qcode{SEEK_END}} (end of file) +or strings @nospell{@qcode{"bof"}}, @nospell{@qcode{"cof"}}, or +@nospell{@qcode{"eof"}}. If @var{origin} is omitted, @w{@qcode{SEEK_SET}} is assumed. @var{offset} may be positive, negative, or zero but not all combinations of @var{origin} and @var{offset} can be realized.