aboutsummaryrefslogtreecommitdiff
path: root/engines
diff options
context:
space:
mode:
authorMax Horn2010-10-23 15:44:55 +0000
committerMax Horn2010-10-23 15:44:55 +0000
commitda31121507db2d92cfbd707d2a08afa9bddf34c2 (patch)
tree754fd0eb727ec028050ad1e7a78fcffcc266ca4f /engines
parent360f67636bdb67eeac80e60b8e27fb88b80fa0fd (diff)
downloadscummvm-rg350-da31121507db2d92cfbd707d2a08afa9bddf34c2.tar.gz
scummvm-rg350-da31121507db2d92cfbd707d2a08afa9bddf34c2.tar.bz2
scummvm-rg350-da31121507db2d92cfbd707d2a08afa9bddf34c2.zip
SAGA: Improve comment for ByteArray::getBuffer()
svn-id: r53736
Diffstat (limited to 'engines')
-rw-r--r--engines/saga/saga.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/engines/saga/saga.h b/engines/saga/saga.h
index 8008cf7bdb..aa66a06352 100644
--- a/engines/saga/saga.h
+++ b/engines/saga/saga.h
@@ -460,8 +460,11 @@ inline uint16 objectIndexToId(int type, int index) {
class ByteArray : public Common::Array<byte> {
public:
-
- byte * getBuffer() { // call this method instead of "&front()" if you insure of array emptyness state
+ /**
+ * Return a pointer to the start of the buffer underlying this byte array,
+ * or NULL if the buffer is empty.
+ */
+ byte *getBuffer() {
return empty() ? NULL : &front();
}
};