diff --git a/string/public/nsPrivateSharableString.h b/string/public/nsPrivateSharableString.h index 14cd13865103..0c34d60d3f4c 100755 --- a/string/public/nsPrivateSharableString.h +++ b/string/public/nsPrivateSharableString.h @@ -41,6 +41,14 @@ class nsPrivateSharableString public: virtual const nsBufferHandle* GetBufferHandle() const; virtual const nsSharedBufferHandle* 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 diff --git a/xpcom/string/public/nsPrivateSharableString.h b/xpcom/string/public/nsPrivateSharableString.h index 14cd13865103..0c34d60d3f4c 100755 --- a/xpcom/string/public/nsPrivateSharableString.h +++ b/xpcom/string/public/nsPrivateSharableString.h @@ -41,6 +41,14 @@ class nsPrivateSharableString public: virtual const nsBufferHandle* GetBufferHandle() const; virtual const nsSharedBufferHandle* 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