Changeset 85836 in vbox for trunk/include/VBox

Timestamp:

Aug 19, 2020 4:24:34 PM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

139998

Message:

Shared Clipboard: Doxygen fixes, make more use of PCRTUTF16 for source arguments.

File:

• trunk/include/VBox/GuestHost/clipboard-helper.h (modified) (6 diffs)

trunk/include/VBox/GuestHost/clipboard-helper.h

@@ -100 +100 @@
  * @param   cwcDst              Where to return the size of the converted string in RTUTF16 units. Includes terminator.
  */
-int ShClConvUtf16LFToCRLFA(RTUTF16 *pwcSrc, size_t cwcSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
+int ShClConvUtf16LFToCRLFA(PCRTUTF16 pcwszSrc, size_t cwcSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
 
 /**
@@ -117 +117 @@
  *
  * @returns VBox status code. Will return VERR_NO_DATA if no data was converted.
- * @param  pwszSrc              UTF-16 string to convert.
+ * @param  pcwszSrc             UTF-16 string to convert.
  * @param  cbSrc                Length of @a pwszSrc (in bytes).
  * @param  pszBuf               Where to write the converted string.
@@ -123 +123 @@
  * @param  pcbLen               Where to store the size (in bytes) of the converted string. Includes terminator.
  */
-int ShClConvUtf16CRLFToUtf8LF(PRTUTF16 pwszSrc, size_t cbSrc, char *pszBuf, size_t cbBuf, size_t *pcbLen);
+int ShClConvUtf16CRLFToUtf8LF(PCRTUTF16 pcwszSrc, size_t cbSrc, char *pszBuf, size_t cbBuf, size_t *pcbLen);
 
 /**
@@ -129 +129 @@
 *
 * @returns VBox status code.
-* @param  pwcSrc                The source text.
-* @param  cwSrc                 Length (in RTUTF16 units) of the source text.
+* @param  pcwszSrc              UTF-16 string to convert.
+* @param  cwcSrc                Length (in RTUTF16 units) of the source text.
 * @param  ppszDst               Where to store the converted result on success.
 * @param  pcbDst                Where to store the number of bytes written.
 */
-int ShClConvUtf16ToUtf8HTML(RTUTF16 *pwcSrc, size_t cwSrc, char **ppszDst, size_t *pcbDst);
+int ShClConvUtf16ToUtf8HTML(PCRTUTF16 pcwszSrc, size_t cwcSrc, char **ppszDst, size_t *pcbDst);
 
 /**
@@ -140 +140 @@
  *
  * @returns VBox status code.
- * @param  pszSrc               UTF-8 string to convert.
+ * @param  pcszSrc              UTF-8 string to convert.
  * @param  cbSrc                Size of UTF-8 string to convert (in bytes), not counting the terminating zero.
  * @param  ppwszDst             Where to return the allocated buffer on success.
  * @param  pcwDst               Where to return the size (in RTUTF16 units) of the allocated buffer on success. Includes terminator.
  */
-int ShClConvUtf8LFToUtf16CRLF(const char *pszSrc, unsigned cbSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
+int ShClConvUtf8LFToUtf16CRLF(const char *pcszSrc, unsigned cbSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
 
 /**
@@ -151 +151 @@
  *
  * @returns VBox status code.
- * @param  pszSrc               UTF-8 string to convert.
+ * @param  pcszSrc              UTF-8 string to convert.
  * @param  cbSrc                Size of string (in bytes), not counting the terminating zero.
  * @param  ppwszDst             Where to return the allocated buffer on success.
  * @param  pcwDst               Where to return the size (in RTUTF16 units) of the allocated buffer on success. Includes terminator.
  */
-int ShClConvLatin1LFToUtf16CRLF(const char *pszSrc, unsigned cbSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
+int ShClConvLatin1LFToUtf16CRLF(const char *pcszSrc, unsigned cbSrc, PRTUTF16 *ppwszDst, size_t *pcwDst);
 
 #pragma pack(1)