More documentation and re-styling of code according to new rules.

[plomrogue] / src / readwrite.h

diff --git a/src/readwrite.h b/src/readwrite.h
index 28bc3ab2316f5a0dfb1e667aec337edf57c90417..a0c8dbabcfe9691dc3ea891c9232c1de3831dd46 100644 (file)
--- a/src/readwrite.h
+++ b/src/readwrite.h
@@ -1,5 +1,22 @@
-uint16_t read_uint16_bigendian(FILE * file);
-void write_uint16_bigendian(uint16_t x, FILE * file);
-uint32_t read_uint32_bigendian(FILE * file);
-void write_uint32_bigendian(uint32_t x, FILE * file);
+/* readwrite.h:
+ *
+ * Routines for reading/writing multibyte data from/to files. They ensure a
+ * defined endianness.
+ */
 
+#ifndef READWRITE_H
+#define READWRITE_H
+
+
+
+#include <stdio.h> /* for FILE typedef */
+#include <stdint.h> /* for uint16_t, uint32_t */
+
+
+
+extern uint16_t read_uint16_bigendian(FILE * file);
+extern uint32_t read_uint32_bigendian(FILE * file);
+extern void write_uint16_bigendian(uint16_t x, FILE * file);
+extern void write_uint32_bigendian(uint32_t x, FILE * file);
+
+#endif