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 84085d27d5e0ac50062d6fc2e4ac3f173bb61235..a0c8dbabcfe9691dc3ea891c9232c1de3831dd46 100644 (file)
--- a/src/readwrite.h
+++ b/src/readwrite.h
@@ -1,14 +1,18 @@
-/*  readwrite.h:
+/* readwrite.h:
  *
- *  Routines for reading/writing multibyte data from/to files. They ensure a
- *  defined endianness.
+ * Routines for reading/writing multibyte data from/to files. They ensure a
+ * defined endianness.
  */
 
 #ifndef READWRITE_H
 #define READWRITE_H
 
-#include <stdio.h>
-#include <stdint.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);