added description on qse_wcsxjoin()

This commit is contained in:
hyung-hwan 2018-01-22 03:04:29 +00:00
parent df76a61d3b
commit fc1748ccd0

View File

@ -1149,7 +1149,7 @@ QSE_EXPORT qse_size_t qse_mbsxjoinv (
); );
/* /**
* The qse_wcsjoin() function joins a list of wide-charcter strings into * The qse_wcsjoin() function joins a list of wide-charcter strings into
* a buffer. The list of strings is terminated by QSE_NULL. * a buffer. The list of strings is terminated by QSE_NULL.
* *
@ -1157,7 +1157,7 @@ QSE_EXPORT qse_size_t qse_mbsxjoinv (
* qse_wcsjoin (x, QSE_T("hello"), QSE_T("world"), QSE_NULL); * qse_wcsjoin (x, QSE_T("hello"), QSE_T("world"), QSE_NULL);
* \endcode * \endcode
* *
* \return the number of character in the joined string excluding * \return the number of characters in the joined string excluding
* the terminating null. * the terminating null.
*/ */
QSE_EXPORT qse_size_t qse_wcsjoin ( QSE_EXPORT qse_size_t qse_wcsjoin (
@ -1165,6 +1165,15 @@ QSE_EXPORT qse_size_t qse_wcsjoin (
... ...
); );
/**
* The qse_wcsxjoin() function acts like qse_wcsjoin() except it doens't
* copy more than size characters. if the buffer is not large enough,
* the result is truncated. If the buffer \a size given is 0, no terminating
* null character is written to the buffer.
*
* \return the number of characters in the joined string excluding
* the terminating null.
*/
QSE_EXPORT qse_size_t qse_wcsxjoin ( QSE_EXPORT qse_size_t qse_wcsxjoin (
qse_wchar_t* buf, qse_wchar_t* buf,
qse_size_t size, qse_size_t size,