Selaa lähdekoodia

qcacmn: Fix pktlog_ac_api.h documentation

The kernel-doc script has identified a couple of documentation issues
in pktlog_ac_api.h, so fix them to the best of our ability.

Change-Id: If5db73e7d019def46d0ba71fb0b01fe4327a521a
CRs-Fixed: 3451053
Jeff Johnson 2 vuotta sitten
vanhempi
sitoutus
c7eaf5ac98
1 muutettua tiedostoa jossa 6 lisäystä ja 8 poistoa
  1. 6 8
      utils/pktlog/include/pktlog_ac_api.h

+ 6 - 8
utils/pktlog/include/pktlog_ac_api.h

@@ -27,24 +27,22 @@
 #define _PKTLOG_AC_API_
 #if defined(CONNECTIVITY_PKTLOG) || !defined(REMOVE_PKT_LOG)
 
+struct hif_opaque_softc;
 /**
- * @typedef hif_opaque_softc_handle
- * @brief opaque handle for hif_opaque_softc
+ * typedef hif_opaque_softc_handle - opaque handle for hif_opaque_softc
  */
-struct hif_opaque_softc;
-typedef struct hif_opaque_softc *hif_opaque_softc_handle;
+typedef struct hif_opaque_softc * hif_opaque_softc_handle;
 
 enum pktlog_callback_regtype {
 	PKTLOG_DEFAULT_CALLBACK_REGISTRATION,
 	PKTLOG_LITE_CALLBACK_REGISTRATION
 };
 
+struct net_device;
 /**
- * @typedef net_device_handle
- * @brief opaque handle linux phy device object
+ * typedef net_device_handle - opaque handle to linux net device object
  */
-struct net_device;
-typedef struct net_device *net_device_handle;
+typedef struct net_device * net_device_handle;
 
 struct pktlog_dev_t;