[docs] Fix Doxygen errors.

Doxygen treats '@code' as the start of a '@code'...'@endcode' block, so
it raised spurious "reached end of file while inside code block" errors
when '@code' was used to denote a parameter. Change these instances to
'\param code' (declaration) and '\p code' (mention).

diff --git a/mono/dis/util.c b/mono/dis/util.c
index 7a54691743479ac40d01742775758a61c55f6cf4..852dcdee4827e952ba798bb6048976f4cce34b7c 100755 (executable)
--- a/mono/dis/util.c
+++ b/mono/dis/util.c
@@ -20,9 +20,8 @@
 #endif
 
 /**
- * map:
- * @code: code to lookup in table
- * @table: table to decode code
+ * \param code code to lookup in table
+ * \param table table to decode code
  *
  * Warning: returns static buffer.
  */
@@ -38,9 +37,8 @@ map (guint32 code, dis_map_t *table)
 }
 
 /**
- * flags:
- * @code: bitfield
- * @table: table to decode bitfield
+ * \param code bitfield
+ * \param table table to decode bitfield
  *
  * Warning: returns static buffer.
  */

diff --git a/mono/metadata/object.c b/mono/metadata/object.c
index 0d9e560fbccec3211096beb3c412252ff5a89e7a..157d4e360ff214e84ee99702b262ca6246244d5a 100644 (file)
--- a/mono/metadata/object.c
+++ b/mono/metadata/object.c
@@ -1646,11 +1646,10 @@ get_generic_virtual_entries (MonoDomain *domain, gpointer *vtable_slot)
 }
 
 /**
- * mono_method_add_generic_virtual_invocation:
- * @domain: a domain
- * @vtable_slot: pointer to the vtable slot
- * @method: the inflated generic virtual method
- * @code: the method's code
+ * \param domain a domain
+ * \param vtable_slot pointer to the vtable slot
+ * \param method the inflated generic virtual method
+ * \param code the method's code
  *
  * Registers a call via unmanaged code to a generic virtual method
  * instantiation or variant interface method.  If the number of calls reaches a threshold

diff --git a/mono/mini/helpers.c b/mono/mini/helpers.c
index 3925249f9d12a1d2e371a1b64d0f87a367e117a5..d5f9545776ef4c46362d301961cd2b2bbb0a00b3 100644 (file)
--- a/mono/mini/helpers.c
+++ b/mono/mini/helpers.c
@@ -126,10 +126,9 @@ mono_blockset_print (MonoCompile *cfg, MonoBitSet *set, const char *name, guint
 }
 
 /**
- * mono_disassemble_code:
- * @cfg: compilation context
- * @code: a pointer to the code
- * @size: the code size in bytes
+ * \param cfg compilation context
+ * \param code a pointer to the code
+ * \param size the code size in bytes
  *
  * Disassemble to code to stdout.
  */

diff --git a/mono/mini/mini-amd64.c b/mono/mini/mini-amd64.c
index c4922a4f2a2edf4e160e0d5f6de70bca5141db16..c3028062610b95bbff0313d3355398e1dce32e0d 100644 (file)
--- a/mono/mini/mini-amd64.c
+++ b/mono/mini/mini-amd64.c
@@ -3502,16 +3502,14 @@ mono_amd64_get_tls_gs_offset (void)
 }
 
 /*
- * mono_amd64_emit_tls_get:
- * @code: buffer to store code to
- * @dreg: hard register where to place the result
- * @tls_offset: offset info
+ * \param code buffer to store code to
+ * \param dreg hard register where to place the result
+ * \param tls_offset offset info
+ * \return a pointer to the end of the stored code
  *
- * mono_amd64_emit_tls_get emits in @code the native code that puts in
+ * mono_amd64_emit_tls_get emits in \p code the native code that puts in
  * the dreg register the item in the thread local storage identified
  * by tls_offset.
- *
- * Returns: a pointer to the end of the stored code
  */
 static guint8*
 mono_amd64_emit_tls_get (guint8* code, int dreg, int tls_offset)
@@ -7597,12 +7595,10 @@ mono_arch_get_patch_offset (guint8 *code)
 }
 
 /**
- * mono_breakpoint_clean_code:
+ * \return TRUE if no sw breakpoint was present.
  *
- * Copy @size bytes from @code - @offset to the buffer @buf. If the debugger inserted software
+ * Copy \p size bytes from \p code - \p offset to the buffer \p buf. If the debugger inserted software
  * breakpoints in the original code, they are removed in the copy.
- *
- * Returns TRUE if no sw breakpoint was present.
  */
 gboolean
 mono_breakpoint_clean_code (guint8 *method_start, guint8 *code, int offset, guint8 *buf, int size)

diff --git a/mono/mini/mini-x86.c b/mono/mini/mini-x86.c
index 78da2b292f23927928fc7226479d0a1641fe3137..6ab899b6ce9edc7fd2bb1d912734f48ada580bbe 100644 (file)
--- a/mono/mini/mini-x86.c
+++ b/mono/mini/mini-x86.c
@@ -5811,12 +5811,10 @@ mono_arch_get_patch_offset (guint8 *code)
 }
 
 /**
- * mono_breakpoint_clean_code:
+ * \return TRUE if no sw breakpoint was present.
  *
- * Copy @size bytes from @code - @offset to the buffer @buf. If the debugger inserted software
+ * Copy \p size bytes from \p code - \p offset to the buffer \p buf. If the debugger inserted software
  * breakpoints in the original code, they are removed in the copy.
- *
- * Returns TRUE if no sw breakpoint was present.
  */
 gboolean
 mono_breakpoint_clean_code (guint8 *method_start, guint8 *code, int offset, guint8 *buf, int size)