From 185f812c419f1b4f0d10d9787d59cf9f11a2a600 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Wed, 19 Jan 2022 18:05:50 +0100 Subject: 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 --- include/crypt.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'include/crypt.h') diff --git a/include/crypt.h b/include/crypt.h index f18a1705d4d..3301f3b7697 100644 --- a/include/crypt.h +++ b/include/crypt.h @@ -9,6 +9,6 @@ * @equal Pointer to an int where the result is stored * '0' = unequal * '1' = equal - * @return 0 on success, error code of errno else + * Return: 0 on success, error code of errno else */ int crypt_compare(const char *should, const char *passphrase, int *equal); -- cgit v1.3.1