bug #67876: r=jst, sr=alecf. Added comment documenting `NULL' string infrastructure.

This commit is contained in:
scc%mozilla.org 2001-02-24 03:11:23 +00:00
parent 1d4f5e20ec
commit 6fd23f001c
2 changed files with 16 additions and 0 deletions

View File

@ -41,6 +41,14 @@ class nsPrivateSharableString
public:
virtual const nsBufferHandle<CharT>* GetBufferHandle() const;
virtual const nsSharedBufferHandle<CharT>* GetSharedBufferHandle() const;
/**
* |GetBufferHandle()| will return either |0|, |1|, or a reasonable pointer.
* The meaning of |0| is that the string points to a non-contiguous or else empty representation.
* The meaning of |1| is implementation dependant.
* Otherwise |GetBufferHandle()| returns a pointer to the single contiguous hunk of characters
* that makes up this string.
*/
};
template <class CharT>

View File

@ -41,6 +41,14 @@ class nsPrivateSharableString
public:
virtual const nsBufferHandle<CharT>* GetBufferHandle() const;
virtual const nsSharedBufferHandle<CharT>* GetSharedBufferHandle() const;
/**
* |GetBufferHandle()| will return either |0|, |1|, or a reasonable pointer.
* The meaning of |0| is that the string points to a non-contiguous or else empty representation.
* The meaning of |1| is implementation dependant.
* Otherwise |GetBufferHandle()| returns a pointer to the single contiguous hunk of characters
* that makes up this string.
*/
};
template <class CharT>