libdeng2|Documentation: Small apidoc update for Writer and Reader

skyjake · Mar 27, 2012 · b138afb · b138afb
1 parent 07dfd0e
commit b138afb
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/doomsday/libdeng2/include/de/data/reader.h b/doomsday/libdeng2/include/de/data/reader.h
@@ -32,8 +32,9 @@ class IReadable;
 class FixedByteArray;
 
 /**
- * Provides a protocol for reading network byte ordered data from a byte array object
- * (anything with a IByteArray interface).
+ * Provides a protocol for reading data from a byte array object (anything with
+ * a IByteArray interface). Byte order defaults to little-endian but can be
+ * changed to big-endian.
  *
  * @ingroup data
  */

diff --git a/doomsday/libdeng2/include/de/data/writer.h b/doomsday/libdeng2/include/de/data/writer.h
@@ -32,8 +32,9 @@ class Block;
 class FixedByteArray;
 
 /**
- * Provides a protocol for writing data in a specific byte order
- * into a byte array object (anything with a IByteArray interface).
+ * Provides a protocol for writing data in a specific byte order into a byte
+ * array object (anything with a IByteArray interface). Defaults to
+ * little-endian byte order.
  *
  * @ingroup data
  */