SubGhz: refactoring add descriptions (#1012)

* SubGhz: add descriptions
* SubGhz: fix syntax

Co-authored-by: あく <alleteam@gmail.com>

lib/subghz/subghz_tx_rx_worker.h

@@ -12,34 +12,34 @@ typedef enum {
     SubGhzTxRxWorkerStatusRx,
 } SubGhzTxRxWorkerStatus;
 
-/** SubGhzTxRxWorker, add data to transfer
- * 
- * @param instance  SubGhzTxRxWorker instance
+/** 
+ * SubGhzTxRxWorker, add data to transfer
+ * @param instance  Pointer to a SubGhzTxRxWorker instance
  * @param data      *data
  * @param size      data size
  * @return bool     true if ok
  */
 bool subghz_tx_rx_worker_write(SubGhzTxRxWorker* instance, uint8_t* data, size_t size);
 
-/** SubGhzTxRxWorker, get available data
- * 
- * @param instance   SubGhzTxRxWorker instance
+/** 
+ * SubGhzTxRxWorker, get available data
+ * @param instance   Pointer to a SubGhzTxRxWorker instance
  * @return size_t    data size
  */
 size_t subghz_tx_rx_worker_available(SubGhzTxRxWorker* instance);
 
-/** SubGhzTxRxWorker, read data
- * 
- * @param instance   SubGhzTxRxWorker instance
+/** 
+ * SubGhzTxRxWorker, read data
+ * @param instance   Pointer to a SubGhzTxRxWorker instance
  * @param data       *data
  * @param size       max data size, which can be read
  * @return size_t    data size, how much is actually read
  */
 size_t subghz_tx_rx_worker_read(SubGhzTxRxWorker* instance, uint8_t* data, size_t size);
 
-/** Сallback SubGhzTxRxWorker when there is data to read in an empty buffer
- * 
- * @param instance SubGhzTxRxWorker instance
+/** 
+ * Сallback SubGhzTxRxWorker when there is data to read in an empty buffer
+ * @param instance Pointer to a SubGhzTxRxWorker instance
  * @param callback SubGhzTxRxWorkerCallbackHaveRead callback
  * @param context
  */
@@ -48,34 +48,34 @@ void subghz_tx_rx_worker_set_callback_have_read(
     SubGhzTxRxWorkerCallbackHaveRead callback,
     void* context);
 
-/** Allocate SubGhzTxRxWorker
- * 
- * @return SubGhzTxRxWorker* 
+/** 
+ * Allocate SubGhzTxRxWorker
+ * @return SubGhzTxRxWorker* Pointer to a SubGhzTxRxWorker instance
  */
 SubGhzTxRxWorker* subghz_tx_rx_worker_alloc();
 
-/** Free SubGhzTxRxWorker
- * 
- * @param instance SubGhzTxRxWorker instance
+/** 
+ * Free SubGhzTxRxWorker
+ * @param instance Pointer to a SubGhzTxRxWorker instance
  */
 void subghz_tx_rx_worker_free(SubGhzTxRxWorker* instance);
 
-/** Start SubGhzTxRxWorker
- * 
- * @param instance SubGhzTxRxWorker instance
+/** 
+ * Start SubGhzTxRxWorker
+ * @param instance Pointer to a SubGhzTxRxWorker instance
  * @return bool - true if ok
  */
 bool subghz_tx_rx_worker_start(SubGhzTxRxWorker* instance, uint32_t frequency);
 
-/** Stop SubGhzTxRxWorker
- * 
- * @param instance SubGhzTxRxWorker instance
+/** 
+ * Stop SubGhzTxRxWorker
+ * @param instance Pointer to a SubGhzTxRxWorker instance
  */
 void subghz_tx_rx_worker_stop(SubGhzTxRxWorker* instance);
 
-/** Check if worker is running
- * 
- * @param instance SubGhzTxRxWorker instance
+/** 
+ * Check if worker is running
+ * @param instance Pointer to a SubGhzTxRxWorker instance
  * @return bool - true if running
  */
 bool subghz_tx_rx_worker_is_running(SubGhzTxRxWorker* instance);