Fixed missing doxygen comments and improved a description in saltdecode.c

1 files changed, 11 insertions, 3 deletions

diff --git a/utils/saltdecode.c b/utils/saltdecode.c
index c597223..137cb10 100644
--- a/utils/saltdecode.c
+++ b/utils/saltdecode.c
@@ -36,8 +36,8 @@
 #include <eurephia_nullsafe.h>
 #include <get_console_input.h>
 
-#define ROUNDS_MIN 1000
-#define ROUNDS_MAX 999999999
+#define ROUNDS_MIN 1000	         /**< Minimum hashing rounds to acknowledge */
+#define ROUNDS_MAX 999999999     /**< Maximum hashing rounds to acknowledge */
 
 
 /**
@@ -85,6 +85,14 @@ unsigned int unpack_saltinfo(const char *insalt, const char *pwd) {
 }
 
 
+/**
+ * saltdecode main function
+ *
+ * @param argc argument counter
+ * @param argv argument table
+ *
+ * @return Returns 0 on success, otherwise 1.
+ */
 int main(int argc, char **argv) {
         char key[258];
         unsigned int saltinfo = 0;
@@ -97,7 +105,7 @@ int main(int argc, char **argv) {
 
         memset(&key, 0, 258);
         printf("\nYou will need to give the correct password for this salt.\n");
-        printf("If you give the wrong password, the information will be decoded wrong.\n\n");
+        printf("If you give the wrong password, the decoded information will be wrong.\n\n");
         get_console_input(key, 256, "Password:", 1);
         saltinfo = unpack_saltinfo(argv[1], key);
         memset(&key, 0, 258);