Fix documentation comment for pg_md5_hash

danielgustafsson · danielgustafsson · commit 6b41ef03306f · 2024-03-14T09:23:37.000+01:00
Commit b69aba7 added the errstr parameter to pg_md5_hash but missed updating the synopsis in the documentation comment. The follow-up commit 587de22 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 <tatsuro.yamada@ntt.com> Discussion: https://postgr.es/m/TYYPR01MB82313576150CC86084A122CD9E292@TYYPR01MB8231.jpnprd01.prod.outlook.com
diff --git a/src/common/md5_common.c b/src/common/md5_common.c
@@ -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.

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,8 @@ bytesToHex(uint8 b[16], char *s)`
`45`	`45`	`* Calculates the MD5 sum of the bytes in a buffer.`
`46`	`46`	`*`
`47`	`47`	`* SYNOPSIS #include "md5.h"`
`48`		`- * int pg_md5_hash(const void buff, size_t len, char hexsum)`
	`48`	`+ * bool pg_md5_hash(const void buff, size_t len, char hexsum,`
	`49`	`+ * const char **errstr)`
`49`	`50`	`*`
`50`	`51`	`* INPUT buff the buffer containing the bytes that you want`
`51`	`52`	`* the MD5 sum of.`