diff options
author | Heinrich Schuchardt | 2022-01-19 18:05:50 +0100 |
---|---|---|
committer | Heinrich Schuchardt | 2022-01-19 18:11:34 +0100 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /include/smem.h | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) |
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>
Diffstat (limited to 'include/smem.h')
-rw-r--r-- | include/smem.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/smem.h b/include/smem.h index 83da9e177e2..b19c534ebc4 100644 --- a/include/smem.h +++ b/include/smem.h @@ -57,7 +57,7 @@ struct smem_ops { * @host: remote processor id, or -1 * @item: smem item handle * @size: number of bytes to be allocated - * @return 0 if OK, -ve on error + * Return: 0 if OK, -ve on error * * Allocate space for a given smem item of size @size, given that the item is * not yet allocated. @@ -69,7 +69,7 @@ int smem_alloc(struct udevice *dev, unsigned int host, unsigned int item, size_t * @host: the remote processor, or -1 for all processors. * @item: smem item handle * @size: pointer to be filled out with size of the item - * @return pointer on success, NULL on error + * Return: pointer on success, NULL on error * * Looks up smem item and returns pointer to it. Size of smem * item is returned in @size. @@ -80,7 +80,7 @@ void *smem_get(struct udevice *dev, unsigned int host, unsigned int item, size_t * smem_get_free_space() - retrieve amount of free space in a partition * @host: the remote processor identifying a partition, or -1 * for all processors. - * @return size in bytes, -ve on error + * Return: size in bytes, -ve on error * * To be used by smem clients as a quick way to determine if any new * allocations has been made. |