Fix documentation comment for pg_md5_hash
authorDaniel Gustafsson <[email protected]>
Thu, 14 Mar 2024 08:23:37 +0000 (09:23 +0100)
committerDaniel Gustafsson <[email protected]>
Thu, 14 Mar 2024 08:23:37 +0000 (09:23 +0100)
Commit b69aba74578 added the errstr parameter to pg_md5_hash but
missed updating the synopsis in the documentation comment.  The
follow-up commit 587de223f03 added the parameter to the list of
outputs.  The returnvalue had been changed from integer to bool
before that but remained in the synopsis.  This fixes both.

Author: Tatsuro Yamada <[email protected]>
Discussion: https://postgr.es/m/TYYPR01MB82313576150CC86084A122CD9E292@TYYPR01MB8231.jpnprd01.prod.outlook.com

src/common/md5_common.c

index 094878479cfe7e8697d6408c7315b2a9aad05f38..c654efe9718ace537ca364b41b0e08e427e1a9f4 100644 (file)
@@ -45,7 +45,8 @@ bytesToHex(uint8 b[16], char *s)
  * Calculates the MD5 sum of the bytes in a buffer.
  *
  * SYNOPSIS      #include "md5.h"
- *               int pg_md5_hash(const void *buff, size_t len, char *hexsum)
+ *               bool pg_md5_hash(const void *buff, size_t len, char *hexsum,
+ *                                const char **errstr)
  *
  * INPUT         buff    the buffer containing the bytes that you want
  *                       the MD5 sum of.