Minor #268 additions

ufna · Feb 13, 2020 · 221f74d · 221f74d
1 parent 6371b53
commit 221f74d
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/Source/VaRest/Public/VaRestLibrary.h b/Source/VaRest/Public/VaRestLibrary.h
@@ -63,9 +63,17 @@ class VAREST_API UVaRestLibrary : public UBlueprintFunctionLibrary
 	UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "Base64 Decode Data"))
 	static bool Base64DecodeData(const FString& Source, TArray<uint8>& Dest);
 
+	/**
+	 * Helper to perform the very common case of hashing an ASCII string into a hex representation.
+	 * 
+	 * @param String	Hex representation of the hash (32 lower-case hex digits)
+	 **/
 	UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "String to MD5"))
 	static FString StringToMd5(const FString& StringToHash);
 
+	/**
+	 * Helper to perform the SHA1 hash operation on string.
+	 **/
 	UFUNCTION(BlueprintCallable, Category = "VaRest|Utility", meta = (DisplayName = "String to SHA1"))
 	static FString StringToSha1(const FString& StringToHash);
 };