Minor adaptions to comments

This commit is contained in:
ceriel 1988-06-16 11:44:31 +00:00
parent 922eba369d
commit 184984d472

View file

@ -6,7 +6,7 @@ DEFINITION MODULE PascalIO;
This module provides for I/O that is essentially equivalent to the I/O This module provides for I/O that is essentially equivalent to the I/O
provided by Pascal with "text", or "file of char". provided by Pascal with "text", or "file of char".
Output buffers are automaically flushed at program termination. Output buffers are automatically flushed at program termination.
The CloseOutput routine is just there for compatibility with earlier The CloseOutput routine is just there for compatibility with earlier
versions of this module. versions of this module.
*) *)
@ -37,7 +37,7 @@ DEFINITION MODULE PascalIO;
*) *)
PROCEDURE CloseOutput(); PROCEDURE CloseOutput();
(* To be called at the end of the program, to flush all output buffers *) (* To be called at the end of the program, to flush all output buffers. *)
(*************************************************************************** (***************************************************************************
Input routines; Input routines;
@ -48,33 +48,33 @@ DEFINITION MODULE PascalIO;
****************************************************************************) ****************************************************************************)
PROCEDURE NextChar(InputText: Text): CHAR; PROCEDURE NextChar(InputText: Text): CHAR;
(* Returns the next character of the InputText, 0C on end of file. (* Returns the next character from the InputText, 0C on end of file.
Does not advance the "read pointer", so behaves much like "input^" Does not advance the "read pointer", so behaves much like "input^"
in Pascal. However, unlike Pascal, if Eoln(InputText) is true, it in Pascal. However, unlike Pascal, if Eoln(InputText) is TRUE, it
returns the newline character, rather than a space. returns the newline character, rather than a space.
*) *)
PROCEDURE Get(InputText: Text); PROCEDURE Get(InputText: Text);
(* Advances the "read pointer" by one character *) (* Advances the "read pointer" by one character. *)
PROCEDURE Eoln(InputText: Text): BOOLEAN; PROCEDURE Eoln(InputText: Text): BOOLEAN;
(* Returns TRUE if the next character of the InputText is a linefeed. (* Returns TRUE if the next character from the InputText is a linefeed.
Unlike Pascal however, it does not produce a runtime error when Unlike Pascal however, it does not produce a runtime error when
called when Eof(InputText) is TRUE. called when Eof(InputText) is TRUE.
*) *)
PROCEDURE Eof(InputText: Text): BOOLEAN; PROCEDURE Eof(InputText: Text): BOOLEAN;
(* Returns TRUE if the end of the InputText is reached *) (* Returns TRUE if the end of the InputText is reached. *)
PROCEDURE ReadChar(InputText: Text; VAR Char: CHAR); PROCEDURE ReadChar(InputText: Text; VAR Char: CHAR);
(* Read a character from the InputText, and leave result in "Char". (* Read a character from the InputText, and leave the result in "Char".
Unlike Pascal, if Eoln(InputText) is true, the newline character Unlike Pascal, if Eoln(InputText) is TRUE, the newline character
is put in "Char". is put in "Char".
*) *)
PROCEDURE ReadLn(InputText: Text); PROCEDURE ReadLn(InputText: Text);
(* Skip the rest of the current line of the InputText, (* Skip the rest of the current line from the InputText,
including the linefeed including the linefeed.
*) *)
PROCEDURE ReadInteger(InputText: Text; VAR Integer: INTEGER); PROCEDURE ReadInteger(InputText: Text; VAR Integer: INTEGER);
@ -109,10 +109,10 @@ DEFINITION MODULE PascalIO;
****************************************************************************) ****************************************************************************)
PROCEDURE WriteChar(OutputText: Text; Char: CHAR); PROCEDURE WriteChar(OutputText: Text; Char: CHAR);
(* Writes the character "Char" to the OutputText *) (* Writes the character "Char" to the OutputText. *)
PROCEDURE WriteLn(OutputText: Text); PROCEDURE WriteLn(OutputText: Text);
(* Writes a linefeed to the OutputText *) (* Writes a linefeed to the OutputText. *)
PROCEDURE Page(OutputText: Text); PROCEDURE Page(OutputText: Text);
(* Writes a form-feed to the OutputText *) (* Writes a form-feed to the OutputText *)
@ -131,15 +131,15 @@ DEFINITION MODULE PascalIO;
(* Write boolean "Boolean" to the OutputText, using at least "Width" places, (* Write boolean "Boolean" to the OutputText, using at least "Width" places,
blank-padding to the left if needed. blank-padding to the left if needed.
Equivalent to WriteString(OutputText, " TRUE", Width), or Equivalent to WriteString(OutputText, " TRUE", Width), or
WriteString(OutputText, "FALSE", Width) WriteString(OutputText, "FALSE", Width).
*) *)
PROCEDURE WriteString(OutputText: Text; PROCEDURE WriteString(OutputText: Text;
String: ARRAY OF CHAR; Width: CARDINAL); String: ARRAY OF CHAR; Width: CARDINAL);
(* Write string "String" to the OutputText, using at least "Width" places, (* Write string "String" to the OutputText, using at least "Width" places,
blank-padding to the left if needed. blank-padding to the left if needed.
The string is terminated either by the character Eos, or the upperbound of The string is terminated either by the character Eos, or by the upperbound
the array "String". of the array "String".
*) *)
PROCEDURE WriteReal(OutputText: Text; Real: REAL; Width, Nfrac: CARDINAL); PROCEDURE WriteReal(OutputText: Text; Real: REAL; Width, Nfrac: CARDINAL);