hs_descriptor.[ch]: repair doxygen comments.

These are yet more that were not made with "/**"

1 files changed, 52 insertions, 52 deletions

diff --git a/src/feature/hs/hs_descriptor.h b/src/feature/hs/hs_descriptor.h
index 0a843f4f3c..731e0c5ce9 100644
--- a/src/feature/hs/hs_descriptor.h
+++ b/src/feature/hs/hs_descriptor.h
@@ -18,88 +18,88 @@
 /* Trunnel */
 struct link_specifier_t;
 
-/* The earliest descriptor format version we support. */
+/** The earliest descriptor format version we support. */
 #define HS_DESC_SUPPORTED_FORMAT_VERSION_MIN 3
-/* The latest descriptor format version we support. */
+/** The latest descriptor format version we support. */
 #define HS_DESC_SUPPORTED_FORMAT_VERSION_MAX 3
 
-/* Default lifetime of a descriptor in seconds. The valus is set at 3 hours
+/** Default lifetime of a descriptor in seconds. The valus is set at 3 hours
  * which is 180 minutes or 10800 seconds. */
 #define HS_DESC_DEFAULT_LIFETIME (3 * 60 * 60)
-/* Maximum lifetime of a descriptor in seconds. The value is set at 12 hours
+/** Maximum lifetime of a descriptor in seconds. The value is set at 12 hours
  * which is 720 minutes or 43200 seconds. */
 #define HS_DESC_MAX_LIFETIME (12 * 60 * 60)
-/* Lifetime of certificate in the descriptor. This defines the lifetime of the
+/** Lifetime of certificate in the descriptor. This defines the lifetime of the
  * descriptor signing key and the cross certification cert of that key. It is
  * set to 54 hours because a descriptor can be around for 48 hours and because
  * consensuses are used after the hour, add an extra 6 hours to give some time
  * for the service to stop using it. */
 #define HS_DESC_CERT_LIFETIME (54 * 60 * 60)
-/* Length of the salt needed for the encrypted section of a descriptor. */
+/** Length of the salt needed for the encrypted section of a descriptor. */
 #define HS_DESC_ENCRYPTED_SALT_LEN 16
-/* Length of the KDF output value which is the length of the secret key,
+/** Length of the KDF output value which is the length of the secret key,
  * the secret IV and MAC key length which is the length of H() output. */
 #define HS_DESC_ENCRYPTED_KDF_OUTPUT_LEN \
   CIPHER256_KEY_LEN + CIPHER_IV_LEN + DIGEST256_LEN
-/* Pad plaintext of superencrypted data section before encryption so that its
+/** Pad plaintext of superencrypted data section before encryption so that its
  * length is a multiple of this value. */
 #define HS_DESC_SUPERENC_PLAINTEXT_PAD_MULTIPLE 10000
-/* Maximum length in bytes of a full hidden service descriptor. */
+/** Maximum length in bytes of a full hidden service descriptor. */
 #define HS_DESC_MAX_LEN 50000 /* 50kb max size */
 
-/* Key length for the descriptor symmetric encryption. As specified in the
+/** Key length for the descriptor symmetric encryption. As specified in the
  * protocol, we use AES-256 for the encrypted section of the descriptor. The
  * following is the length in bytes and the bit size. */
 #define HS_DESC_ENCRYPTED_KEY_LEN CIPHER256_KEY_LEN
 #define HS_DESC_ENCRYPTED_BIT_SIZE (HS_DESC_ENCRYPTED_KEY_LEN * 8)
 
-/* Length of each components in the auth client section in the descriptor. */
+/** Length of each components in the auth client section in the descriptor. */
 #define HS_DESC_CLIENT_ID_LEN 8
 #define HS_DESC_DESCRIPTOR_COOKIE_LEN 16
 #define HS_DESC_COOKIE_KEY_LEN 32
 #define HS_DESC_COOKIE_KEY_BIT_SIZE (HS_DESC_COOKIE_KEY_LEN * 8)
 #define HS_DESC_ENCRYPED_COOKIE_LEN HS_DESC_DESCRIPTOR_COOKIE_LEN
 
-/* The number of auth client entries in the descriptor must be the multiple
+/** The number of auth client entries in the descriptor must be the multiple
  * of this constant. */
 #define HS_DESC_AUTH_CLIENT_MULTIPLE 16
 
-/* Type of authentication in the descriptor. */
+/** Type of authentication in the descriptor. */
 typedef enum {
   HS_DESC_AUTH_ED25519 = 1
 } hs_desc_auth_type_t;
 
-/* Introduction point information located in a descriptor. */
+/** Introduction point information located in a descriptor. */
 typedef struct hs_desc_intro_point_t {
-  /* Link specifier(s) which details how to extend to the relay. This list
+  /** Link specifier(s) which details how to extend to the relay. This list
    * contains link_specifier_t objects. It MUST have at least one. */
   smartlist_t *link_specifiers;
 
-  /* Onion key of the introduction point used to extend to it for the ntor
+  /** Onion key of the introduction point used to extend to it for the ntor
    * handshake. */
   curve25519_public_key_t onion_key;
 
-  /* Authentication key used to establish the introduction point circuit and
+  /** Authentication key used to establish the introduction point circuit and
    * cross-certifies the blinded public key for the replica thus signed by
    * the blinded key and in turn signs it. */
   tor_cert_t *auth_key_cert;
 
-  /* Encryption key for the "ntor" type. */
+  /** Encryption key for the "ntor" type. */
   curve25519_public_key_t enc_key;
 
-  /* Certificate cross certifying the descriptor signing key by the encryption
+  /** Certificate cross certifying the descriptor signing key by the encryption
    * curve25519 key. This certificate contains the signing key and is of type
    * CERT_TYPE_CROSS_HS_IP_KEYS [0B]. */
   tor_cert_t *enc_key_cert;
 
-  /* (Optional): If this introduction point is a legacy one that is version <=
+  /** (Optional): If this introduction point is a legacy one that is version <=
    * 0.2.9.x (HSIntro=3), we use this extra key for the intro point to be able
    * to relay the cells to the service correctly. */
   struct {
-    /* RSA public key. */
+    /** RSA public key. */
     crypto_pk_t *key;
 
-    /* Cross certified cert with the descriptor signing key (RSA->Ed). Because
+    /** Cross certified cert with the descriptor signing key (RSA->Ed). Because
      * of the cross certification API, we need to keep the certificate binary
      * blob and its length in order to properly encode it after. */
     struct {
@@ -108,115 +108,115 @@ typedef struct hs_desc_intro_point_t {
     } cert;
   } legacy;
 
-  /* True iff the introduction point has passed the cross certification. Upon
+  /** True iff the introduction point has passed the cross certification. Upon
    * decoding an intro point, this must be true. */
   unsigned int cross_certified : 1;
 } hs_desc_intro_point_t;
 
-/* Authorized client information located in a descriptor. */
+/** Authorized client information located in a descriptor. */
 typedef struct hs_desc_authorized_client_t {
-  /* An identifier that the client will use to identify which auth client
+  /** An identifier that the client will use to identify which auth client
    * entry it needs to use. */
   uint8_t client_id[HS_DESC_CLIENT_ID_LEN];
 
-  /* An IV that is used to decrypt the encrypted descriptor cookie. */
+  /** An IV that is used to decrypt the encrypted descriptor cookie. */
   uint8_t iv[CIPHER_IV_LEN];
 
-  /* An encrypted descriptor cookie that the client needs to decrypt to use
+  /** An encrypted descriptor cookie that the client needs to decrypt to use
    * it to decrypt the descriptor. */
   uint8_t encrypted_cookie[HS_DESC_ENCRYPED_COOKIE_LEN];
 } hs_desc_authorized_client_t;
 
-/* The encrypted data section of a descriptor. Obviously the data in this is
+/** The encrypted data section of a descriptor. Obviously the data in this is
  * in plaintext but encrypted once encoded. */
 typedef struct hs_desc_encrypted_data_t {
-  /* Bitfield of CREATE2 cell supported formats. The only currently supported
+  /** Bitfield of CREATE2 cell supported formats. The only currently supported
    * format is ntor. */
   unsigned int create2_ntor : 1;
 
-  /* A list of authentication types that a client must at least support one
+  /** A list of authentication types that a client must at least support one
    * in order to contact the service. Contains NULL terminated strings. */
   smartlist_t *intro_auth_types;
 
-  /* Is this descriptor a single onion service? */
+  /** Is this descriptor a single onion service? */
   unsigned int single_onion_service : 1;
 
-  /* A list of intro points. Contains hs_desc_intro_point_t objects. */
+  /** A list of intro points. Contains hs_desc_intro_point_t objects. */
   smartlist_t *intro_points;
 } hs_desc_encrypted_data_t;
 
-/* The superencrypted data section of a descriptor. Obviously the data in
+/** The superencrypted data section of a descriptor. Obviously the data in
  * this is in plaintext but encrypted once encoded. */
 typedef struct hs_desc_superencrypted_data_t {
-  /* This field contains ephemeral x25519 public key which is used by
+  /** This field contains ephemeral x25519 public key which is used by
    * the encryption scheme in the client authorization. */
   curve25519_public_key_t auth_ephemeral_pubkey;
 
-  /* A list of authorized clients. Contains hs_desc_authorized_client_t
+  /** A list of authorized clients. Contains hs_desc_authorized_client_t
    * objects. */
   smartlist_t *clients;
 
-  /* Decoding only: The b64-decoded encrypted blob from the descriptor */
+  /** Decoding only: The b64-decoded encrypted blob from the descriptor */
   uint8_t *encrypted_blob;
 
-  /* Decoding only: Size of the encrypted_blob */
+  /** Decoding only: Size of the encrypted_blob */
   size_t encrypted_blob_size;
 } hs_desc_superencrypted_data_t;
 
-/* Plaintext data that is unencrypted information of the descriptor. */
+/** Plaintext data that is unencrypted information of the descriptor. */
 typedef struct hs_desc_plaintext_data_t {
-  /* Version of the descriptor format. Spec specifies this field as a
+  /** Version of the descriptor format. Spec specifies this field as a
    * positive integer. */
   uint32_t version;
 
-  /* The lifetime of the descriptor in seconds. */
+  /** The lifetime of the descriptor in seconds. */
   uint32_t lifetime_sec;
 
-  /* Certificate with the short-term ed22519 descriptor signing key for the
+  /** Certificate with the short-term ed22519 descriptor signing key for the
    * replica which is signed by the blinded public key for that replica. */
   tor_cert_t *signing_key_cert;
 
-  /* Signing public key which is used to sign the descriptor. Same public key
+  /** Signing public key which is used to sign the descriptor. Same public key
    * as in the signing key certificate. */
   ed25519_public_key_t signing_pubkey;
 
-  /* Blinded public key used for this descriptor derived from the master
+  /** Blinded public key used for this descriptor derived from the master
    * identity key and generated for a specific replica number. */
   ed25519_public_key_t blinded_pubkey;
 
-  /* Revision counter is incremented at each upload, regardless of whether
+  /** Revision counter is incremented at each upload, regardless of whether
    * the descriptor has changed. This avoids leaking whether the descriptor
    * has changed. Spec specifies this as a 8 bytes positive integer. */
   uint64_t revision_counter;
 
-  /* Decoding only: The b64-decoded superencrypted blob from the descriptor */
+  /** Decoding only: The b64-decoded superencrypted blob from the descriptor */
   uint8_t *superencrypted_blob;
 
-  /* Decoding only: Size of the superencrypted_blob */
+  /** Decoding only: Size of the superencrypted_blob */
   size_t superencrypted_blob_size;
 } hs_desc_plaintext_data_t;
 
-/* Service descriptor in its decoded form. */
+/** Service descriptor in its decoded form. */
 typedef struct hs_descriptor_t {
-  /* Contains the plaintext part of the descriptor. */
+  /** Contains the plaintext part of the descriptor. */
   hs_desc_plaintext_data_t plaintext_data;
 
-  /* The following contains what's in the superencrypted part of the
+  /** The following contains what's in the superencrypted part of the
    * descriptor. It's only encrypted in the encoded version of the descriptor
    * thus the data contained in that object is in plaintext. */
   hs_desc_superencrypted_data_t superencrypted_data;
 
-  /* The following contains what's in the encrypted part of the descriptor.
+  /** The following contains what's in the encrypted part of the descriptor.
    * It's only encrypted in the encoded version of the descriptor thus the
    * data contained in that object is in plaintext. */
   hs_desc_encrypted_data_t encrypted_data;
 
-  /* Subcredentials of a service, used by the client and service to decrypt
+  /** Subcredentials of a service, used by the client and service to decrypt
    * the encrypted data. */
   uint8_t subcredential[DIGEST256_LEN];
 } hs_descriptor_t;
 
-/* Return true iff the given descriptor format version is supported. */
+/** Return true iff the given descriptor format version is supported. */
 static inline int
 hs_desc_is_supported_version(uint32_t version)
 {