SAGA: Improve comment for ByteArray::getBuffer()

svn-id: r53736
This commit is contained in:
Max Horn
2010-10-23 15:44:55 +00:00
parent 360f67636b
commit da31121507
+5 -2
View File
@@ -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();
}
};