Added prototype description

rg3 · May 14, 2015 · 2e6a010 · 2e6a010
1 parent 5babb78
commit 2e6a010
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/bcrypt.h b/bcrypt.h
@@ -46,6 +46,12 @@ int bcrypt_gensalt(int workfactor, char salt[BCRYPT_HASHSIZE]);
 int bcrypt_hashpw(const char *passwd, const char salt[BCRYPT_HASHSIZE],
 		  char hash[BCRYPT_HASHSIZE]);
 
+/*
+ * This function expects a password and a hash to verify the password against.
+ *
+ * The return value is zero if the password verification failed and one
+ * otherwise.
+ */
 int bcrypt_verify(const char *passwd, const char hash[BCRYPT_HASHSIZE]);
 
 /*