From: Jon Purdy Date: Thu, 9 Mar 2017 01:20:48 +0000 (-0800) Subject: [docs] Update formatting in mono-api-embedding. X-Git-Url: http://wien.tomnetworks.com/gitweb/?a=commitdiff_plain;h=41f760c673395a6bd499745573507bc6580e8b37;p=mono.git [docs] Update formatting in mono-api-embedding. --- diff --git a/mono/metadata/domain.c b/mono/metadata/domain.c index a8a7db99f30..12e88ace7cc 100644 --- a/mono/metadata/domain.c +++ b/mono/metadata/domain.c @@ -810,15 +810,15 @@ mono_init_from_assembly (const char *domain_name, const char *filename) /** * mono_init_version: * - * Used by the runtime, users should use mono_jit_init instead. + * Used by the runtime, users should use \c mono_jit_init instead. * - * Creates the initial application domain and initializes the mono_defaults + * Creates the initial application domain and initializes the \c mono_defaults * structure. * * This function is guaranteed to not run any IL code. * The runtime is initialized using the provided rutime version. * - * Returns: the initial domain. + * \returns the initial domain. */ MonoDomain * mono_init_version (const char *domain_name, const char *version) diff --git a/mono/metadata/icall.c b/mono/metadata/icall.c index 99fe267bff4..f4be3b65402 100644 --- a/mono/metadata/icall.c +++ b/mono/metadata/icall.c @@ -8111,15 +8111,16 @@ mono_icall_cleanup (void) * * For example, the following are all valid declarations: * - * "MyApp.Services.ScriptService:Accelerate" - * "MyApp.Services.ScriptService:Slowdown(int,bool)" + * \c MyApp.Services.ScriptService:Accelerate + * + * \c MyApp.Services.ScriptService:Slowdown(int,bool) * * You use method parameters in cases where there might be more than * one surface method to managed code. That way you can register different * internal calls for different method overloads. * * The internal calls are invoked with no marshalling. This means that .NET - * types like System.String are exposed as `MonoString *` parameters. This is + * types like \c System.String are exposed as \c MonoString* parameters. This is * different than the way that strings are surfaced in P/Invoke. * * For more information on how the parameters are marshalled, see the diff --git a/mono/metadata/mono-config.c b/mono/metadata/mono-config.c index 8b4c0c9ff82..6a56a43e13c 100644 --- a/mono/metadata/mono-config.c +++ b/mono/metadata/mono-config.c @@ -465,6 +465,9 @@ mono_config_init (void) g_hash_table_insert (config_handlers, (gpointer) aot_cache_handler.element_name, (gpointer) &aot_cache_handler); } +/** + * mono_config_cleanup: + */ void mono_config_cleanup (void) { @@ -581,6 +584,9 @@ mono_register_config_for_assembly (const char* assembly_name, const char* config bundled_configs = bconfig; } +/** + * mono_config_string_for_assembly_file: + */ const char * mono_config_string_for_assembly_file (const char *filename) { @@ -670,7 +676,10 @@ mono_config_parse (const char *filename) { #endif } -/* Invoked during startup */ +/** + * mono_set_config_dir: + * Invoked during startup + */ void mono_set_config_dir (const char *dir) { @@ -680,6 +689,9 @@ mono_set_config_dir (const char *dir) mono_cfg_dir = mono_cfg_dir_allocated = g_strdup (dir); } +/** + * mono_get_config_dir: + */ const char* mono_get_config_dir (void) { @@ -689,12 +701,18 @@ mono_get_config_dir (void) return mono_cfg_dir; } +/** + * mono_register_machine_config: + */ void mono_register_machine_config (const char *config_xml) { bundled_machine_config = config_xml; } +/** + * mono_get_machine_config: + */ const char * mono_get_machine_config (void) { @@ -890,12 +908,18 @@ mono_config_parse_assembly_bindings (const char *filename, int amajor, int amino static mono_bool mono_server_mode = FALSE; +/** + * mono_config_set_server_mode: + */ void mono_config_set_server_mode (mono_bool server_mode) { mono_server_mode = server_mode; } +/** + * mono_config_is_server_mode: + */ mono_bool mono_config_is_server_mode (void) { diff --git a/mono/metadata/object.c b/mono/metadata/object.c index 496aded1f07..e86f743c29f 100644 --- a/mono/metadata/object.c +++ b/mono/metadata/object.c @@ -3988,7 +3988,7 @@ free_main_args (void) * \param argc number of arguments from the command line * \param argv array of strings from the command line * Set the command line arguments from an embedding application that doesn't otherwise call - * mono_runtime_run_main(). + * \c mono_runtime_run_main. */ int mono_runtime_set_main_args (int argc, char* argv[]) diff --git a/mono/mini/driver.c b/mono/mini/driver.c index 310c9f070e2..9e09e7a944e 100644 --- a/mono/mini/driver.c +++ b/mono/mini/driver.c @@ -273,6 +273,9 @@ mono_parse_graph_options (const char* p) exit (1); } +/** + * mono_parse_default_optimizations: + */ int mono_parse_default_optimizations (const char* p) { @@ -1359,11 +1362,11 @@ static const char info[] = static gboolean enable_debugging; -/* +/** * mono_jit_parse_options: * - * Process the command line options in ARGV as done by the runtime executable. - * This should be called before mono_jit_init (). + * Process the command line options in \p argv as done by the runtime executable. + * This should be called before \c mono_jit_init. */ void mono_jit_parse_options (int argc, char * argv[]) @@ -2286,6 +2289,9 @@ mono_main (int argc, char* argv[]) return 0; } +/** + * mono_jit_init: + */ MonoDomain * mono_jit_init (const char *file) { @@ -2318,6 +2324,9 @@ mono_jit_init_version (const char *domain_name, const char *runtime_version) return mini_init (domain_name, runtime_version); } +/** + * mono_jit_cleanup: + */ void mono_jit_cleanup (MonoDomain *domain) { @@ -2332,6 +2341,9 @@ mono_jit_set_aot_only (gboolean val) mono_aot_only = val; } +/** + * mono_jit_set_aot_mode: + */ void mono_jit_set_aot_mode (MonoAotMode mode) { @@ -2373,14 +2385,14 @@ mono_jit_set_trace_options (const char* options) /** * mono_set_signal_chaining: * - * Enable/disable signal chaining. This should be called before mono_jit_init (). + * Enable/disable signal chaining. This should be called before \c mono_jit_init. * If signal chaining is enabled, the runtime saves the original signal handlers before * installing its own handlers, and calls the original ones in the following cases: - * - a SIGSEGV/SIGABRT signal received while executing native (i.e. not JITted) code. - * - SIGPROF - * - SIGFPE - * - SIGQUIT - * - SIGUSR2 + * - a \c SIGSEGV / \c SIGABRT signal received while executing native (i.e. not JITted) code. + * - \c SIGPROF + * - \c SIGFPE + * - \c SIGQUIT + * - \c SIGUSR2 * Signal chaining only works on POSIX platforms. */ void diff --git a/mono/mini/method-to-ir.c b/mono/mini/method-to-ir.c index 342f357f466..18533d77026 100644 --- a/mono/mini/method-to-ir.c +++ b/mono/mini/method-to-ir.c @@ -4884,13 +4884,13 @@ static MonoBreakPolicyFunc break_policy_func = always_insert_breakpoint; * \param policy_callback the new callback function * * Allow embedders to decide wherther to actually obey breakpoint instructions - * (both break IL instructions and \c Debugger.Break() method calls), for example + * (both break IL instructions and \c Debugger.Break method calls), for example * to not allow an app to be aborted by a perfectly valid IL opcode when executing * untrusted or semi-trusted code. * * \p policy_callback will be called every time a break point instruction needs to - * be inserted with the method argument being the method that calls \c Debugger.Break() - * or has the IL break instruction. The callback should return \c MONO_BREAK_POLICY_NEVER + * be inserted with the method argument being the method that calls \c Debugger.Break + * or has the IL \c break instruction. The callback should return \c MONO_BREAK_POLICY_NEVER * if it wants the breakpoint to not be effective in the given method. * \c MONO_BREAK_POLICY_ALWAYS is the default. */ diff --git a/mono/mini/mini-runtime.c b/mono/mini/mini-runtime.c index 3451c566fe8..dd84089f64f 100644 --- a/mono/mini/mini-runtime.c +++ b/mono/mini/mini-runtime.c @@ -4199,7 +4199,7 @@ mono_set_verbose_level (guint32 level) /** * mono_get_runtime_build_info: * The returned string is owned by the caller. The returned string - * format is "VERSION (FULL_VERSION BUILD_DATE)" and build date is optional. + * format is VERSION (FULL_VERSION BUILD_DATE) and build date is optional. * \returns the runtime version + build date in string format. */ char*