Clarify docs for auth.cpp method

est31 · est31 · commit 254dbe7abd25 · 2015-07-21T18:14:39.000+02:00
diff --git a/src/util/auth.cpp b/src/util/auth.cpp
@@ -57,9 +57,9 @@ void getSRPVerifier(const std::string &name,
 }
 
 // Get a db-ready SRP verifier
-// The salt param is only modifyable by this method so that you can free it
-// if it was allocated. You shouldn't use it for other purposes, as you will
-// need the contents of salt_len too.
+// If the salt param is NULL, one is automatically generated.
+// Please free() it afterwards. You shouldn't use it for other purposes,
+// as you will need the contents of salt_len too.
 inline static std::string getSRPVerifier(const std::string &name,
 	const std::string &password, char ** salt, size_t salt_len)
 {

Original file line number	Diff line number	Diff line change
`@@ -57,9 +57,9 @@ void getSRPVerifier(const std::string &name,`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`// Get a db-ready SRP verifier`
`60`		`-// The salt param is only modifyable by this method so that you can free it`
`61`		`-// if it was allocated. You shouldn't use it for other purposes, as you will`
`62`		`-// need the contents of salt_len too.`
	`60`	`+// If the salt param is NULL, one is automatically generated.`
	`61`	`+// Please free() it afterwards. You shouldn't use it for other purposes,`
	`62`	`+// as you will need the contents of salt_len too.`
`63`	`63`	`inline static std::string getSRPVerifier(const std::string &name,`
`64`	`64`	`const std::string &password, char ** salt, size_t salt_len)`
`65`	`65`	`{`