add documentation for new methods

Author: bamx23

Source/KSCrash/Recording/KSCrash.h

@@ -233,14 +233,28 @@ typedef enum
  */
 - (void) sendAllReportsWithCompletion:(KSCrashReportFilterCompletion) onCompletion;
 
+/** Get all unsent report IDs.
+ *
+ * @return An array with report IDs.
+ */
 - (NSArray*) reportIDs;
 
+/** Get report.
+ *
+ * @param reportID An ID of report.
+ *
+ * @return A dictionary with report fields. See KSCrashReportFields.h for available fields.
+ */
 - (NSDictionary*) reportWithID:(NSNumber*) reportID;
 
 /** Delete all unsent reports.
  */
 - (void) deleteAllReports;
 
+/** Delete report.
+ *
+ * @param report_id An ID of report to delete.
+ */
 - (void) deleteReportWithID:(NSNumber*) reportID;
 
 /** Report a custom, user defined exception.

Source/KSCrash/Recording/KSCrashC.c

@@ -295,7 +295,7 @@ void kscrash_deleteAllReports()
     kscrs_deleteAllReports();
 }
 
-void kscrash_deleteReportWithID(int64_t id)
+void kscrash_deleteReportWithID(int64_t reportId)
 {
-    kscrs_deleteReportWithID(id);
+    kscrs_deleteReportWithID(reportId);
 }

Source/KSCrash/Recording/KSCrashC.h

@@ -228,7 +228,11 @@ int64_t kscrash_addUserReport(const char* report, int reportLength);
  */
 void kscrash_deleteAllReports(void);
 
-void kscrash_deleteReportWithID(int64_t id);
+/** Delete report.
+ *
+ * @param report_id An ID of report to delete.
+ */
+void kscrash_deleteReportWithID(int64_t reportId);
 
 
 #ifdef __cplusplus

Source/KSCrash/Recording/KSCrashReportStore.c

@@ -258,10 +258,10 @@ void kscrs_deleteAllReports()
     pthread_mutex_unlock(&g_mutex);
 }
 
-void kscrs_deleteReportWithID(int64_t id)
+void kscrs_deleteReportWithID(int64_t reportId)
 {
     char path[KSCRS_MAX_PATH_LENGTH];
-    getCrashReportPathByID(id, path);
+    getCrashReportPathByID(reportId, path);
     ksfu_removeFile(path, true);
 }
 

Source/KSCrash/Recording/KSCrashReportStore.h

@@ -85,7 +85,11 @@ int64_t kscrs_addUserReport(const char* report, int reportLength);
  */
 void kscrs_deleteAllReports(void);
 
-void kscrs_deleteReportWithID(int64_t id);
+/** Delete report.
+ *
+ * @param report_id An ID of report to delete.
+ */
+void kscrs_deleteReportWithID(int64_t reportId);
 
 /** Set the maximum number of reports allowed on disk before old ones get deleted.
  *