search

copperspice / cs_string

Header-only library providing unicode aware string support for C++
https://www.copperspice.com/
Other
105 stars 12 forks source link

Documentation for constData() wrong? #12

Closed PDHCoder closed 2 years ago

PDHCoder commented 2 years ago

There seems to be an error in the documentation of the constData() method: it should have return type "const typename E::storage_unit *" and not "void".

From https://www.copperspice.com/docs/cs_string/class_csstring_1_1csbasicstring.html#ac353b4a5bfcdfde79571314d373fbd04

template<typename E, typename A = std::allocator> void CsString::CsBasicString< E, A >::constData() const

Returns a pointer to the null terminated data stored in this CsBasicString. The pointer is valid until the string is modified.

bgeller commented 2 years ago

Thanks for reporting this, we will make the correction.

bgeller commented 2 years ago

Just uploaded new CsString documentation.