qcacmn: Correct the kernel-doc format

Correct kernel-doc format for the functions in file utils_mlo.h.

Change-Id: I5a91675867885d8fdf262c7ea7f98a09f9e2e539
CRs-Fixed: 3203893

umac/mlo_mgr/inc/utils_mlo.h

@@ -95,11 +95,7 @@ util_gen_link_assoc_rsp(uint8_t *frame, qdf_size_t frame_len, bool isreassoc,
 			qdf_size_t *link_frame_len);
 
 /**
- * util_find_mlie - Find the first Multi-Link element or the start of the first
- * Multi-Link element fragment sequence in a given buffer containing elements,
- * if a Multi-Link element or element fragment sequence exists in the given
- * buffer.
- *
+ * util_find_mlie() - Find the  Multi-Link element
  * @buf: Buffer to be searched for the Multi-Link element or the start of the
  * Multi-Link element fragment sequence
  * @buflen: Length of the buffer
@@ -114,6 +110,11 @@ util_gen_link_assoc_rsp(uint8_t *frame, qdf_size_t frame_len, bool isreassoc,
  * returns error, or if the function indicates that the element or element
  * fragment sequence was not found by providing a starting address of NULL.
  *
+ * Find the first Multi-Link element or the start of the first
+ * Multi-Link element fragment sequence in a given buffer containing elements,
+ * if a Multi-Link element or element fragment sequence exists in the given
+ * buffer.
+ *
  * Return: QDF_STATUS_SUCCESS in the case of success, QDF_STATUS value giving
  * the reason for error in the case of failure
  */
@@ -122,9 +123,7 @@ util_find_mlie(uint8_t *buf, qdf_size_t buflen, uint8_t **mlieseq,
 	       qdf_size_t *mlieseqlen);
 
 /**
- * util_get_mlie_variant - Get the variant of the given Multi-Link element or
- * element fragment sequence.
- *
+ * util_get_mlie_variant() - Get ML IE variant
  * @mlieseq: Starting address of the Multi-Link element or Multi-Link element
  * fragment sequence
  * @mlieseqlen: Total length of the Multi-Link element or Multi-Link element
@@ -137,6 +136,8 @@ util_find_mlie(uint8_t *buf, qdf_size_t buflen, uint8_t **mlieseq,
  * ultimately result in an error). The value should be ignored by the caller if
  * the function returns error.
  *
+ * Get the variant of the given Multi-Link element or element fragment sequence.
+ *
  * Return: QDF_STATUS_SUCCESS in the case of success, QDF_STATUS value giving
  * the reason for error in the case of failure
  */
@@ -145,9 +146,7 @@ util_get_mlie_variant(uint8_t *mlieseq, qdf_size_t mlieseqlen,
 		      int *variant);
 
 /**
- * util_get_bvmlie_mldmacaddr - Get the MLD MAC address from a given Basic
- * variant Multi-Link element or element fragment sequence.
- *
+ * util_get_bvmlie_mldmacaddr() - Get the MLD MAC address
  * @mlieseq: Starting address of the Multi-Link element or Multi-Link element
  * fragment sequence
  * @mlieseqlen: Total length of the Multi-Link element or Multi-Link element
@@ -155,6 +154,9 @@ util_get_mlie_variant(uint8_t *mlieseq, qdf_size_t mlieseqlen,
  * @linkid: Pointer to the location where the MLD MAC address should be updated.
  * This should be ignored by the caller if the function returns error.
  *
+ * Get the MLD MAC address from a given Basic variant Multi-Link element
+ * or element fragment sequence.
+ *
  * Return: QDF_STATUS_SUCCESS in the case of success, QDF_STATUS value giving
  * the reason for error in the case of failure
  */
@@ -163,8 +165,7 @@ util_get_bvmlie_mldmacaddr(uint8_t *mlieseq, qdf_size_t mlieseqlen,
 			   struct qdf_mac_addr *mldmacaddr);
 
 /**
- * util_get_bvmlie_eml_cap - Get the EML capabilities from a given Basic
- * variant Multi-Link element or element fragment sequence.
+ * util_get_bvmlie_eml_cap() - Get the EML capabilities
  * @mlieseq: Starting address of the Multi-Link element or Multi-Link element
  * fragment sequence
  * @mlieseqlen: Total length of the Multi-Link element or Multi-Link element
@@ -173,9 +174,11 @@ util_get_bvmlie_mldmacaddr(uint8_t *mlieseq, qdf_size_t mlieseqlen,
  * updated indicating whether the EML cabalility was found or not. This should
  * be ignored by the caller if the function returns error.
  * @eml_cap: Pointer to the location where the EML capabilities should be
- * updated.
- * This should be ignored by the caller if the function indicates that the
- * EML capability was not found.
+ * updated. This should be ignored by the caller if the function indicates
+ * that the EML capability was not found.
+ *
+ * Get the EML capabilities from a given Basic variant Multi-Link element or
+ * element fragment sequence.
  *
  * Return: QDF_STATUS_SUCCESS in the case of success, QDF_STATUS value giving
  * the reason for error in the case of failure
@@ -186,13 +189,7 @@ util_get_bvmlie_eml_cap(uint8_t *mlieseq, qdf_size_t mlieseqlen,
 			uint16_t *eml_cap);
 
 /**
- * util_get_bvmlie_primary_linkid - Get the link identifier from a given Basic
- * variant Multi-Link element or element fragment sequence, of the AP that
- * transmits the Multi-Link element/element fragment sequence or the
- * nontransmitted BSSID in the same multiple BSSID set as the AP that transmits
- * the Multi-Link element/element fragment sequence and that is affiliated with
- * the MLD that is described in the Multi-Link element.
- *
+ * util_get_bvmlie_primary_linkid() - Get the link identifier
  * @mlieseq: Starting address of the Multi-Link element or Multi-Link element
  * fragment sequence
  * @mlieseqlen: Total length of the Multi-Link element or Multi-Link element
@@ -205,6 +202,13 @@ util_get_bvmlie_eml_cap(uint8_t *mlieseq, qdf_size_t mlieseqlen,
  * returns error, or if the function indicates that the link identifier was not
  * found.
  *
+ * Get the link identifier from a given Basic variant Multi-Link element or
+ * element fragment sequence, of the AP that transmits the Multi-Link
+ * element/element fragment sequence or the nontransmitted BSSID in the same
+ * multiple BSSID set as the AP that transmits the Multi-Link element/element
+ * fragment sequence and that is affiliated with the MLD that is described in
+ * the Multi-Link element.
+ *
  * Return: QDF_STATUS_SUCCESS in the case of success, QDF_STATUS value giving
  * the reason for error in the case of failure
  */
@@ -258,13 +262,7 @@ util_get_bvmlie_bssparamchangecnt(uint8_t *mlieseq, qdf_size_t mlieseqlen,
 				  uint8_t *bssparamchangecnt);
 
 /**
- * util_get_bvmlie_mldcap - Get the MLD capabilities from a given Basic
- * variant Multi-Link element or element fragment sequence, of the AP that
- * transmits the Multi-Link element/element fragment sequence or the
- * nontransmitted BSSID in the same multiple BSSID set as the AP that transmits
- * the Multi-Link element/element fragment sequence and that is affiliated with
- * the MLD that is described in the Multi-Link element.
- *
+ * util_get_bvmlie_mldcap() - Get the MLD capabilities
  * @mlieseq: Starting address of the Multi-Link element or Multi-Link element
  * fragment sequence
  * @mlieseqlen: Total length of the Multi-Link element or Multi-Link element
@@ -277,6 +275,13 @@ util_get_bvmlie_bssparamchangecnt(uint8_t *mlieseq, qdf_size_t mlieseqlen,
  * returns error, or if the function indicates that the MLD capabilities was not
  * found.
  *
+ * Get the MLD capabilities from a given Basic variant Multi-Link element or
+ * element fragment sequence, of the AP that transmits the Multi-Link
+ * element/element fragment sequence or the nontransmitted BSSID in the same
+ * multiple BSSID set as the AP that transmits the Multi-Link element/element
+ * fragment sequence and that is affiliated with the MLD that is described in
+ * the Multi-Link element.
+ *
  * Return: QDF_STATUS_SUCCESS in the case of success, QDF_STATUS value giving
  * the reason for error in the case of failure
  */
@@ -286,7 +291,6 @@ util_get_bvmlie_mldcap(uint8_t *mlieseq, qdf_size_t mlieseqlen,
 
 /**
  * util_get_bvmlie_persta_partner_info() - Get per-STA partner link information
- *
  * @mlieseq: Starting address of the Multi-Link element or Multi-Link element
  * fragment sequence
  * @mlieseqlen: Total length of the Multi-Link element or Multi-Link element