refactoring: change variable names and attach descriptive comments in calculatorGetUserInput.c

src/calculatorGetUserInput.c

@@ -1,20 +1,25 @@
 #include "calculatorGetUserInput.h"
+// Note:
+/* This Function may or may not be implemented in actual program, even if it is merged to the main branch.
+   If it is temporarily not included in the main Program, then this has a role in future Development of the Project */
 
-int allowOnly()
+int allowOnly()   //int allowOnly() is helpful for indirectly testing void calculatorGetUserInput().
 {
-    if( a == 1)
+    if(a == 1)
     {
-    return 1;
+        return 1;
     }
 }
 
-void calculatorGetUserInput(float *x, float *y)
+void calculatorGetUserInput(float *num1, float *num2)
 {
-    if (allowOnly() == 1)
+    if (allowOnly() == 1)   //only if int allowOnly() returns 1, void calculatorGetUserInput will display the desired output.
     {
-    printf("number1: ");
-    scanf("%f", x);
-    printf("number2: ");
-    scanf("%f", y);
+        printf("number1: ");
+        scanf("%f", num1);
+        printf("number2: ");
+        scanf("%f", num2);
     }
 }
+
+

src/calculatorGetUserInput.h

@@ -2,7 +2,8 @@
 #define CALCULATORGETUSERINPUT_H
 #include<stdio.h>
 #include<stdlib.h>
-void calculatorGetUserInput(float *x, float *y);
-const int a = 1;
+void calculatorGetUserInput(float *num1, float *num2);
+int allowOnly();
+const int a = 1; //Just a random constant which has a role in testing
 
 #endif // CALCULATORGETUSERINPUT_H