]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
put doxygen file marker in isc/crypto.h
authorAydın Mercan <aydin@isc.org>
Wed, 18 Feb 2026 08:49:29 +0000 (11:49 +0300)
committerAydın Mercan <aydin@isc.org>
Tue, 14 Jul 2026 13:40:49 +0000 (16:40 +0300)
While Doxygen isn't necessarily used, developers might still opt to
use it's syntax comments on LSPs and other toolchains.

lib/isc/include/isc/crypto.h

index 0d64f1cb1dde7af955107cfb04e0242062c5467a..6bae97377d061564fd2c7b7c6c62eb99ad73e415 100644 (file)
@@ -13,6 +13,8 @@
 
 #pragma once
 
+/*! \file isc/crypto.h */
+
 #include <stddef.h>
 #include <stdint.h>
 
@@ -277,15 +279,17 @@ isc_crypto_quic_hp_protect_mask(isc_crypto_quic_hp_protect_t *prot,
 
 bool
 isc_crypto_fips_mode(void);
-/*
+/**<
  * Return if FIPS mode is currently enabled or not.
  */
 
 isc_result_t
 isc_crypto_fips_enable(void);
-/*
+/**<
+ * \brief
  * Enable FIPS mode. It cannot be disabled afterwards.
  *
+ * \warning
  * This function is NOT thread safe.
  */