i#4856: Add Doxygen links for instr_t (#7700)

This PR adds explicit `#` Doxygen links for `instr_t` in various header
files, as discussed in issue #4856.

Fixes #4856

Author: AnandRaj2224

clients/drcachesim/drpt2trace/pt2ir.h

@@ -358,7 +358,7 @@ class pt2ir_t {
     /**
      * The convert function performs two processes: (1) decode the PT raw trace into
      * libipt's IR format pt_insn; (2) convert pt_insn into the DynamoRIO's IR format
-     * instr_t and append it to ilist inside the drir object.
+     * #instr_t and append it to ilist inside the drir object.
      * @param pt_data The PT raw trace.
      * @param pt_data_size The size of PT raw trace.
      * @param drir The drir object.

clients/drcachesim/tracer/raw2trace_shared.h

@@ -484,7 +484,7 @@ print_module_data_fields(char *dst, size_t max_len, const void *custom_data,
 
 /**
  * Subclasses module_mapper_t and replaces the module loading with a buffer
- * of encoded instr_t. Useful for tests where we want to mock the module
+ * of encoded #instr_t. Useful for tests where we want to mock the module
  * files with an in-memory buffer of instrs.
  */
 class test_module_mapper_t : public module_mapper_t {

core/ir/aarch64/instr_create_api.h

@@ -53,7 +53,7 @@
  *   5) instr_create macros
  *   6) suite/tests/api/ir* tests
  */
-/** Opcode constants for use in the instr_t data structure. */
+/** Opcode constants for use in the #instr_t data structure. */
 enum {
     /*   0 */ OP_INVALID,
     /* NULL, */ /**< INVALID opcode */

core/ir/arm/instr_create_api.h

@@ -65,7 +65,7 @@ DR_API
  * (xref instr_get_raw_bits()).
  * Assumes that \p instr is already initialized, but uses the x86/x64 mode
  * for the thread \p dcontext rather than that set in instr.
- * If caller is re-using same instr_t struct over multiple decodings,
+ * If caller is re-using same #instr_t struct over multiple decodings,
  * caller should call instr_reset() or instr_reuse().
  * Returns the address of the next byte after the decoded instruction.
  * Returns NULL on decoding an invalid instr and sets opcode to OP_INVALID.
@@ -88,7 +88,7 @@ DR_API
  * all filled in.
  * Assumes that \p instr is already initialized, but uses the x86/x64 mode
  * for the thread \p dcontext rather than that set in instr.
- * If caller is re-using same instr_t struct over multiple decodings,
+ * If caller is re-using same #instr_t struct over multiple decodings,
  * caller should call instr_reset() or instr_reuse().
  * Returns the address of the next byte after the decoded instruction
  * copy at \p copy_pc.

core/ir/arm/opcode_api.h

@@ -212,8 +212,8 @@ DR_API
  * Encodes \p instr into the memory at \p pc.
  * Uses the x86/x64 mode stored in instr, not the mode of the current thread.
  * Returns the pc after the encoded instr, or NULL if the encoding failed.
- * If instr is a cti with an instr_t target, the offset fields of instr and
- * of the target must be set with the respective offsets of each instr_t!
+ * If instr is a cti with an #instr_t target, the offset fields of instr and
+ * of the target must be set with the respective offsets of each #instr_t!
  * (instrlist_encode does this automatically, if the target is in the list).
  * x86 instructions can occupy up to 17 bytes, so the caller should ensure
  * the target location has enough room to avoid overflow.
@@ -234,8 +234,8 @@ DR_API
  *
  * Uses the x86/x64 mode stored in instr, not the mode of the current thread.
  * Returns the pc after the encoded instr, or NULL if the encoding failed.
- * If instr is a cti with an instr_t target, the offset fields of instr and
- * of the target must be set with the respective offsets of each instr_t!
+ * If instr is a cti with an #instr_t target, the offset fields of instr and
+ * of the target must be set with the respective offsets of each #instr_t!
  * (instrlist_encode does this automatically, if the target is in the list).
  * x86 instructions can occupy up to 17 bytes, so the caller should ensure
  * the target location has enough room to avoid overflow.
@@ -253,10 +253,10 @@ DR_API
  * at \p pc.  Returns the pc after all of the encodings, or NULL if any one
  * of the encodings failed.
  * Uses the x86/x64 mode stored in each instr, not the mode of the current thread.
- * In order for instr_t operands to be encoded properly,
+ * In order for #instr_t operands to be encoded properly,
  * \p has_instr_jmp_targets must be true.  If \p has_instr_jmp_targets is true,
- * the offset field of each instr_t in ilist will be overwritten, and if any
- * instr_t targets are not in \p ilist, they must have their offset fields set with
+ * the offset field of each #instr_t in ilist will be overwritten, and if any
+ * #instr_t targets are not in \p ilist, they must have their offset fields set with
  * their offsets relative to pc.
  * x86 instructions can occupy up to 17 bytes each, so the caller should ensure
  * the target location has enough room to avoid overflow.
@@ -278,10 +278,10 @@ DR_API
  *
  * Uses the x86/x64 mode stored in each instr, not the mode of the current thread.
  *
- * In order for instr_t operands to be encoded properly,
+ * In order for #instr_t operands to be encoded properly,
  * \p has_instr_jmp_targets must be true.  If \p has_instr_jmp_targets is true,
- * the offset field of each instr_t in ilist will be overwritten, and if any
- * instr_t targets are not in \p ilist, they must have their offset fields set with
+ * the offset field of each #instr_t in ilist will be overwritten, and if any
+ * #instr_t targets are not in \p ilist, they must have their offset fields set with
  * their offsets relative to pc.
  *
  * If \p max_pc is non-NULL, computes the total size required to encode the

core/ir/decode_api.h

@@ -428,7 +428,7 @@ instr_get_translation(instr_t *instr);
 DR_UNS_API
 /**
  * Brings all instrs in ilist up to the decode_cti level, and
- * hooks up intra-ilist cti targets to use instr_t targets, by
+ * hooks up intra-ilist cti targets to use #instr_t targets, by
  * matching pc targets to each instruction's raw bits.
  *
  * decode_cti decodes only enough of instr to determine
@@ -602,31 +602,31 @@ instr_create_nbyte_nop(dcontext_t *dcontext, uint num_bytes, bool raw);
 
 DR_UNS_API
 /**
- * Convenience routine that returns an initialized instr_t with invalid operands
+ * Convenience routine that returns an initialized #instr_t with invalid operands
  * and allocated raw bits with 1 byte (byte).
  */
 instr_t *
 instr_create_raw_1byte(dcontext_t *dcontext, byte byte);
 
 DR_UNS_API
 /**
- * Convenience routine that returns an initialized instr_t with invalid operands
+ * Convenience routine that returns an initialized #instr_t with invalid operands
  * and allocated raw bits with 2 bytes (byte1, byte2).
  */
 instr_t *
 instr_create_raw_2bytes(dcontext_t *dcontext, byte byte1, byte byte2);
 
 DR_UNS_API
 /**
- * Convenience routine that returns an initialized instr_t with invalid operands
+ * Convenience routine that returns an initialized #instr_t with invalid operands
  * and allocated raw bits with 3 bytes (byte1, byte2, byte3).
  */
 instr_t *
 instr_create_raw_3bytes(dcontext_t *dcontext, byte byte1, byte byte2, byte byte3);
 
 DR_UNS_API
 /**
- * Convenience routine that returns an initialized instr_t with invalid operands
+ * Convenience routine that returns an initialized #instr_t with invalid operands
  * and allocated raw bits with 4 bytes (byte1, byte2, byte3, byte4).
  */
 instr_t *
@@ -635,7 +635,7 @@ instr_create_raw_4bytes(dcontext_t *dcontext, byte byte1, byte byte2, byte byte3
 
 DR_UNS_API
 /**
- * Convenience routine that returns an initialized instr_t with invalid operands
+ * Convenience routine that returns an initialized #instr_t with invalid operands
  * and allocated raw bits with 5 bytes (byte1, byte2, byte3, byte4, byte5).
  */
 instr_t *
@@ -644,7 +644,7 @@ instr_create_raw_5bytes(dcontext_t *dcontext, byte byte1, byte byte2, byte byte3
 
 DR_UNS_API
 /**
- * Convenience routine that returns an initialized instr_t with invalid operands
+ * Convenience routine that returns an initialized #instr_t with invalid operands
  * and allocated raw bits with 6 bytes (byte1, byte2, byte3, byte4, byte5, byte6).
  */
 instr_t *
@@ -653,7 +653,7 @@ instr_create_raw_6bytes(dcontext_t *dcontext, byte byte1, byte byte2, byte byte3
 
 DR_UNS_API
 /**
- * Convenience routine that returns an initialized instr_t with invalid operands
+ * Convenience routine that returns an initialized #instr_t with invalid operands
  * and allocated raw bits with 7 bytes (byte1, byte2, byte3, byte4, byte5, byte6,
  * byte7).
  */
@@ -663,7 +663,7 @@ instr_create_raw_7bytes(dcontext_t *dcontext, byte byte1, byte byte2, byte byte3
 
 DR_UNS_API
 /**
- * Convenience routine that returns an initialized instr_t with invalid operands
+ * Convenience routine that returns an initialized #instr_t with invalid operands
  * and allocated raw bits with 7 bytes (byte1, byte2, byte3, byte4, byte5, byte6,
  * byte7, byte8).
  */