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>
diff --git a/include/crypt.h b/include/crypt.h
index f18a170..3301f3b 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);