From: Jon Purdy <evincarofautumn@gmail.com>
Date: Thu, 9 Mar 2017 21:29:09 +0000 (-0800)
Subject: [docs] Update formatting in mono-api-jit.
X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=commitdiff_plain;h=60c26e4dd9d21ccf0291ae82fe6eaff6db169561;p=mono.git

[docs] Update formatting in mono-api-jit.
---

diff --git a/mono/metadata/appdomain.c b/mono/metadata/appdomain.c
index 4d0ccb89282..8caf43ff239 100644
--- a/mono/metadata/appdomain.c
+++ b/mono/metadata/appdomain.c
@@ -422,6 +422,9 @@ mono_runtime_cleanup (MonoDomain *domain)
 
 static MonoDomainFunc quit_function = NULL;
 
+/**
+ * mono_install_runtime_cleanup:
+ */
 void
 mono_install_runtime_cleanup (MonoDomainFunc func)
 {
diff --git a/mono/metadata/environment.c b/mono/metadata/environment.c
index 5f7c3f66a6b..2ccf0fe7217 100644
--- a/mono/metadata/environment.c
+++ b/mono/metadata/environment.c
@@ -28,12 +28,20 @@ extern MonoString* ves_icall_System_Environment_GetOSVersionString (void);
 
 static gint32 exitcode=0;
 
-gint32 mono_environment_exitcode_get (void)
+/**
+ * mono_environment_exitcode_get:
+ */
+gint32
+mono_environment_exitcode_get (void)
 {
 	return(exitcode);
 }
 
-void mono_environment_exitcode_set (gint32 value)
+/**
+ * mono_environment_exitcode_set:
+ */
+void
+mono_environment_exitcode_set (gint32 value)
 {
 	exitcode=value;
 }
diff --git a/mono/metadata/runtime.c b/mono/metadata/runtime.c
index 8c2e2123c3e..913a0e06e5e 100644
--- a/mono/metadata/runtime.c
+++ b/mono/metadata/runtime.c
@@ -28,11 +28,10 @@ static gboolean shutting_down = FALSE;
 
 /** 
  * mono_runtime_set_shutting_down:
+ * \deprecated This function can break the shutdown sequence.
  *
- * Invoked by System.Environment.Exit to flag that the runtime
+ * Invoked by \c System.Environment.Exit to flag that the runtime
  * is shutting down.
- *
- * Deprecated. This function can break the shutdown sequence.
  */
 void
 mono_runtime_set_shutting_down (void)
diff --git a/mono/mini/mini-exceptions.c b/mono/mini/mini-exceptions.c
index 3345988779d..cacc74c49bc 100644
--- a/mono/mini/mini-exceptions.c
+++ b/mono/mini/mini-exceptions.c
@@ -2671,11 +2671,11 @@ mono_print_thread_dump_internal (void *sigctx, MonoContext *start_ctx)
 	mono_runtime_stdout_fflush ();
 }
 
-/*
+/**
  * mono_print_thread_dump:
  *
- *   Print information about the current thread to stdout.
- * SIGCTX can be NULL, allowing this to be called from gdb.
+ * Print information about the current thread to stdout.
+ * \p sigctx can be NULL, allowing this to be called from gdb.
  */
 void
 mono_print_thread_dump (void *sigctx)
diff --git a/mono/mini/mini-runtime.c b/mono/mini/mini-runtime.c
index dd84089f64f..d8f22a99a33 100644
--- a/mono/mini/mini-runtime.c
+++ b/mono/mini/mini-runtime.c
@@ -235,21 +235,17 @@ mono_pmip (void *ip)
 }
 
 /**
- * mono_print_method_from_ip
+ * mono_print_method_from_ip:
  * \param ip an instruction pointer address
  *
  * This method is used from a debugger to get the name of the
  * method at address \p ip.
  *
  * This prints the name of the method at address \p ip in the standard
- * output.  Unlike mono_pmip which returns a string, this routine
+ * output.  Unlike \c mono_pmip which returns a string, this routine
  * prints the value on the standard output.
  */
-#ifdef __GNUC__
-/* Prevent the linker from optimizing this away in embedding setups to help debugging */
- __attribute__ ((__used__))
-#endif
-void
+MONO_ATTR_USED void
 mono_print_method_from_ip (void *ip)
 {
 	MonoJitInfo *ji;