Add docs

Sources/KSCrashRecording/include/KSCrash.h

@@ -127,7 +127,17 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (BOOL)installWithConfiguration:(KSCrashConfiguration *)configuration error:(NSError **)error;
 
-/** TODO: Add docs
+/** Sets up the crash repors store.
+ * A call of this method is required before working with crash reports.
+ * The `installWithConfiguration:error:` method sets up the crash report store. 
+ * You only need to call this method if you are not using the `installWithConfiguration:error:` method 
+ * or want to read crash reports from a custom location.
+ *
+ * @note This method can be called multiple times, but only before `installWithConfiguration:error:` is called.
+ *
+ * @param installPath The path to the directory where the crash reports are stored. If `nil`, the default path is used.
+ * @param error A pointer to an NSError object. If an error occurs, this pointer is set to an actual error object.
+ * @return YES if the crash report store was successfully set up, NO otherwise.
  */
 - (BOOL)setupReportStoreWithPath:(nullable NSString *)installPath error:(NSError **)error;
 
@@ -136,8 +146,9 @@ NS_ASSUME_NONNULL_BEGIN
  * deleted. Once the reports are successfully sent to the server, they may be
  * deleted locally, depending on the property "deleteAfterSendAll".
  *
- * Note: property "sink" MUST be set or else this method will call onCompletion
- *       with an error.
+ * @note A call of `setupReportStoreWithPath:error:` or `installWithConfiguration:error:` is required
+ *       before working with crash reports.
+ * @note Property "sink" MUST be set or else this method will call `onCompletion` with an error.
  *
  * @param onCompletion Called when sending is complete (nil = ignore).
  */
@@ -147,6 +158,9 @@ NS_ASSUME_NONNULL_BEGIN
 @property(nonatomic, readonly, strong) NSArray<NSNumber *> *reportIDs;
 
 /** Get report.
+ *
+ * @note A call of `setupReportStoreWithPath:error:` or `installWithConfiguration:error:` is required
+ *       before working with crash reports.
  *
  * @param reportID An ID of report.
  *
@@ -155,10 +169,15 @@ NS_ASSUME_NONNULL_BEGIN
 - (nullable KSCrashReportDictionary *)reportForID:(int64_t)reportID NS_SWIFT_NAME(report(for:));
 
 /** Delete all unsent reports.
+ * @note A call of `setupReportStoreWithPath:error:` or `installWithConfiguration:error:` is required
+ *       before working with crash reports.
  */
 - (void)deleteAllReports;
 
 /** Delete report.
+ * 
+ * @note A call of `setupReportStoreWithPath:error:` or `installWithConfiguration:error:` is required
+ *       before working with crash reports.
  *
  * @param reportID An ID of report to delete.
  */

Sources/KSCrashRecording/include/KSCrashC.h

@@ -85,7 +85,17 @@ extern "C" {
 KSCrashInstallErrorCode kscrash_install(const char *appName, const char *const installPath,
                                         KSCrashCConfiguration configuration);
 
-/** TODO: Add docs
+/** Sets up the crash repors store.
+ * This function is used to initialize the storage for crash reports.
+ * The `kscrash_install` function sets up the reports store internally.
+ * You only need to call this function if you are not using the `kscrash_install` function 
+ * or want to read crash reports from a custom location.
+ * 
+ * @note this function can be called multiple times, but only before `kscrash_install` is called.
+ * 
+ * @param appName The name of the application. Usually it's bundle name.
+ * @param installPath The directory where the crash reports and related data will be stored.
+ * @return KSCrashInstallErrorCode indicating the result of the setup.
  */
 KSCrashInstallErrorCode kscrash_setupReportsStore(const char *appName, const char *const installPath);