]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
quic: use @-style Doxygen tags in ossl_quic_srtm_remove doc comment
authorNikola Pajkovsky <nikolap@openssl.org>
Wed, 22 Jul 2026 05:37:25 +0000 (07:37 +0200)
committerNikola Pajkovsky <nikolap@openssl.org>
Mon, 3 Aug 2026 12:03:12 +0000 (14:03 +0200)
Convert the doc comment for ossl_quic_srtm_remove() from backslash-style
Doxygen tags (\brief, \param, \return) to the @-style equivalents
(@brief, @param, @returns), matching the STYLE.md convention.

Complements: 63afe639141f "quic: report SRTM entry match status via an output argument"
Signed-off-by: Nikola Pajkovsky <nikolap@openssl.org>
Reviewed-by: Saša Nedvědický <sashan@openssl.org>
Reviewed-by: Jakub Zelenka <jakub.zelenka@openssl.foundation>
Reviewed-by: Eugene Syromiatnikov <esyr@openssl.org>
MergeDate: Mon Aug  3 12:03:18 2026
(Merged from https://github.com/openssl/openssl/pull/32037)

include/internal/quic_srtm.h

index 77c0af6ac408430170cefe07bfe163a73bb1332e..5349bddd93ab560b1003a36e77d84e185f9bad08 100644 (file)
@@ -71,18 +71,18 @@ int ossl_quic_srtm_add(QUIC_SRTM *srtm, void *opaque, uint64_t seq_num,
     const QUIC_STATELESS_RESET_TOKEN *token);
 
 /**
- * \brief Removes an entry identified by its (opaque, seq_num) tuple.
+ * @brief Removes an entry identified by its (opaque, seq_num) tuple.
  *
  * The absence of a matching entry is not an error.
  *
- * \param srtm     SRTM instance to remove the entry from.
- * \param opaque   Opaque pointer identifying the entry.
- * \param seq_num  Sequence number identifying the entry.
- * \param match    If non-NULL, \c *match is set to 1 if a matching entry was
+ * @param srtm     SRTM instance to remove the entry from.
+ * @param opaque   Opaque pointer identifying the entry.
+ * @param seq_num  Sequence number identifying the entry.
+ * @param match    If non-NULL, @c *match is set to 1 if a matching entry was
  *                 found or to 0 if not. May be NULL if this information is not
  *                 required.
  *
- * \return 1 on success and 0 on internal error.
+ * @returns 1 on success and 0 on internal error.
  */
 int ossl_quic_srtm_remove(QUIC_SRTM *srtm, void *opaque, uint64_t seq_num,
     uint8_t *match);