X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fmisc.h;h=568c56d432c5d9d572fb37c4f22f2025a86ac825;hb=0568c1c0f6735509f2a1afea31ecb5dc28f26bf4;hp=5c9d3c4f3244027f7ba0985aa422648d8a20236d;hpb=2f0b15e05b0df7e10a2d0bb04ce4648455d980a8;p=plomrogue diff --git a/src/misc.h b/src/misc.h index 5c9d3c4..568c56d 100644 --- a/src/misc.h +++ b/src/misc.h @@ -17,10 +17,12 @@ struct Map; -/* Learn from "file" the largest line length (pointed to by "linemax_p") and - * (pointed to by "n_lines_p" if it is not set to NULL) the number of lines. +/* Learn from "file" the largest line length (pointed to by "linemax_p"; length + * includes newline chars) and (pointed to by "n_lines_p" if it is not set to + * NULL) the number of lines (= number of newline chars). * - * Returns 0 on success, 1 on fseek() error. + * Returns 0 on success, 1 on error of fseek() (called to return to initial file + * reading position). */ extern uint8_t textfile_sizes(FILE * file, uint16_t * linemax_p, uint16_t * n_lines_p);