doc: replace @return by Return:

Sphinx expects Return: and not @return to indicate a return value.

find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

2 files changed, 7 insertions, 7 deletions

diff --git a/lib/zstd/bitstream.h b/lib/zstd/bitstream.h
index 73aacc97f4..44abfd5eb2 100644
--- a/lib/zstd/bitstream.h
+++ b/lib/zstd/bitstream.h
@@ -127,7 +127,7 @@ static const unsigned BIT_mask[] = {0,       1,       3,       7,	0xF,      0x1F
 ****************************************************************/
 /*! BIT_initCStream() :
  *  `dstCapacity` must be > sizeof(void*)
- *  @return : 0 if success,
+ *  Return: 0 if success,
 			  otherwise an error code (can be tested using ERR_isError() ) */
 ZSTD_STATIC size_t BIT_initCStream(BIT_CStream_t *bitC, void *startPtr, size_t dstCapacity)
 {
@@ -184,7 +184,7 @@ ZSTD_STATIC void BIT_flushBits(BIT_CStream_t *bitC)
 }
 
 /*! BIT_closeCStream() :
- *  @return : size of CStream, in bytes,
+ *  Return: size of CStream, in bytes,
 			  or 0 if it could not fit into dstBuffer */
 ZSTD_STATIC size_t BIT_closeCStream(BIT_CStream_t *bitC)
 {
@@ -259,7 +259,7 @@ ZSTD_STATIC size_t BIT_getLowerBits(size_t bitContainer, U32 const nbBits) { ret
  *  local register is not modified.
  *  On 32-bits, maxNbBits==24.
  *  On 64-bits, maxNbBits==56.
- *  @return : value extracted
+ *  Return: value extracted
  */
 ZSTD_STATIC size_t BIT_lookBits(const BIT_DStream_t *bitD, U32 nbBits)
 {
@@ -280,7 +280,7 @@ ZSTD_STATIC void BIT_skipBits(BIT_DStream_t *bitD, U32 nbBits) { bitD->bitsConsu
 /*! BIT_readBits() :
  *  Read (consume) next n bits from local register and update.
  *  Pay attention to not read more than nbBits contained into local register.
- *  @return : extracted value.
+ *  Return: extracted value.
  */
 ZSTD_STATIC size_t BIT_readBits(BIT_DStream_t *bitD, U32 nbBits)
 {
diff --git a/lib/zstd/decompress.c b/lib/zstd/decompress.c
index ae3be3f02a..edfddd817e 100644
--- a/lib/zstd/decompress.c
+++ b/lib/zstd/decompress.c
@@ -306,7 +306,7 @@ unsigned long long ZSTD_getFrameContentSize(const void *src, size_t srcSize)
  *  compatible with legacy mode
  *  `srcSize` must be the exact length of some number of ZSTD compressed and/or
  *      skippable frames
- *  @return : decompressed size of the frames contained */
+ *  Return: decompressed size of the frames contained */
 unsigned long long ZSTD_findDecompressedSize(const void *src, size_t srcSize)
 {
 	{
@@ -1497,7 +1497,7 @@ size_t ZSTD_generateNxBytes(void *dst, size_t dstCapacity, BYTE byte, size_t len
  *  compatible with legacy mode
  *  `src` must point to the start of a ZSTD frame, ZSTD legacy frame, or skippable frame
  *  `srcSize` must be at least as large as the frame contained
- *  @return : the compressed size of the frame starting at `src` */
+ *  Return: the compressed size of the frame starting at `src` */
 size_t ZSTD_findFrameCompressedSize(const void *src, size_t srcSize)
 {
 	if (srcSize >= ZSTD_skippableHeaderSize && (ZSTD_readLE32(src) & 0xFFFFFFF0U) == ZSTD_MAGIC_SKIPPABLE_START) {
@@ -1860,7 +1860,7 @@ static size_t ZSTD_refDictContent(ZSTD_DCtx *dctx, const void *dict, size_t dict
 
 /* ZSTD_loadEntropy() :
  * dict : must point at beginning of a valid zstd dictionary
- * @return : size of entropy tables read */
+ * Return: size of entropy tables read */
 static size_t ZSTD_loadEntropy(ZSTD_entropyTables_t *entropy, const void *const dict, size_t const dictSize)
 {
 	const BYTE *dictPtr = (const BYTE *)dict;