From 4735975f0ca02c566702d2d7549571534c2a0f07 Mon Sep 17 00:00:00 2001 From: Jon Purdy Date: Wed, 8 Mar 2017 16:41:50 -0800 Subject: [PATCH] [docs] Update formatting in mono-api-debug. --- mono/metadata/debug-mono-symfile.c | 28 ++++++++++++++++++++-------- mono/metadata/mono-debug.c | 22 +++++++++++++++++----- 2 files changed, 37 insertions(+), 13 deletions(-) diff --git a/mono/metadata/debug-mono-symfile.c b/mono/metadata/debug-mono-symfile.c index f456a8e0a45..838707510ce 100644 --- a/mono/metadata/debug-mono-symfile.c +++ b/mono/metadata/debug-mono-symfile.c @@ -139,6 +139,9 @@ load_symfile (MonoDebugHandle *handle, MonoSymbolFile *symfile, mono_bool in_the return TRUE; } +/** + * mono_debug_open_mono_symbols: + */ MonoSymbolFile * mono_debug_open_mono_symbols (MonoDebugHandle *handle, const uint8_t *raw_contents, int size, gboolean in_the_debugger) @@ -187,6 +190,9 @@ mono_debug_open_mono_symbols (MonoDebugHandle *handle, const uint8_t *raw_conten return symfile; } +/** + * mono_debug_close_mono_symbol_file: + */ void mono_debug_close_mono_symbol_file (MonoSymbolFile *symfile) { @@ -210,6 +216,9 @@ mono_debug_close_mono_symbol_file (MonoSymbolFile *symfile) mono_debugger_unlock (); } +/** + * mono_debug_symfile_is_loaded: + */ mono_bool mono_debug_symfile_is_loaded (MonoSymbolFile *symfile) { @@ -299,10 +308,10 @@ check_line (StatementMachine *stm, int offset, MonoDebugSourceLocation **locatio /** * mono_debug_symfile_lookup_location: - * \param minfo A \c MonoDebugMethodInfo which can be retrieved by mono_debug_lookup_method(). + * \param minfo A \c MonoDebugMethodInfo which can be retrieved by \c mono_debug_lookup_method. * \param offset IL offset within the corresponding method's CIL code. * - * This function is similar to mono_debug_lookup_location(), but we + * This function is similar to \c mono_debug_lookup_location, but we * already looked up the method and also already did the * native address -> IL offset mapping. */ @@ -425,11 +434,11 @@ add_line (StatementMachine *stm, GPtrArray *il_offset_array, GPtrArray *line_num stm->first_file = stm->file; } -/* +/** * mono_debug_symfile_free_location: * - * Free a MonoDebugSourceLocation returned by - * mono_debug_symfile_lookup_location + * Free a \c MonoDebugSourceLocation returned by + * \c mono_debug_symfile_lookup_location */ void mono_debug_symfile_free_location (MonoDebugSourceLocation *location) @@ -726,6 +735,9 @@ compare_method (const void *key, const void *object) return token - read32(&(me->_token)); } +/** + * mono_debug_symfile_lookup_method: + */ MonoDebugMethodInfo * mono_debug_symfile_lookup_method (MonoDebugHandle *handle, MonoMethod *method) { @@ -773,12 +785,12 @@ mono_debug_symfile_lookup_method (MonoDebugHandle *handle, MonoMethod *method) return minfo; } -/* +/** * mono_debug_symfile_lookup_locals: * - * Return information about the local variables of MINFO from the symbol file. + * Return information about the local variables of \p minfo from the symbol file. * Return NULL if no information can be found. - * The result should be freed using mono_debug_symfile_free_locals (). + * The result should be freed using \c mono_debug_symfile_free_locals. */ MonoDebugLocalsInfo* mono_debug_symfile_lookup_locals (MonoDebugMethodInfo *minfo) diff --git a/mono/metadata/mono-debug.c b/mono/metadata/mono-debug.c index 0d86302aaaf..b1a40b6ae5f 100644 --- a/mono/metadata/mono-debug.c +++ b/mono/metadata/mono-debug.c @@ -178,6 +178,9 @@ mono_debug_cleanup (void) } } +/** + * mono_debug_domain_create: + */ void mono_debug_domain_create (MonoDomain *domain) { @@ -223,6 +226,9 @@ mono_debug_get_image (MonoImage *image) return (MonoDebugHandle *)g_hash_table_lookup (mono_debug_handles, image); } +/** + * mono_debug_close_image: + */ void mono_debug_close_image (MonoImage *image) { @@ -333,7 +339,7 @@ mono_debug_lookup_method_internal (MonoMethod *method) * * Lookup symbol file information for the method \p method. The returned * \c MonoDebugMethodInfo is a private structure, but it can be passed to - * mono_debug_symfile_lookup_location(). + * \c mono_debug_symfile_lookup_location. */ MonoDebugMethodInfo * mono_debug_lookup_method (MonoMethod *method) @@ -431,6 +437,9 @@ write_variable (MonoDebugVarInfo *var, guint8 *ptr, guint8 **rptr) *rptr = ptr; } +/** + * mono_debug_add_method: + */ MonoDebugMethodAddress * mono_debug_add_method (MonoMethod *method, MonoDebugMethodJitInfo *jit, MonoDomain *domain) { @@ -530,6 +539,9 @@ mono_debug_remove_method (MonoMethod *method, MonoDomain *domain) mono_debugger_unlock (); } +/** + * mono_debug_add_delegate_trampoline: + */ void mono_debug_add_delegate_trampoline (gpointer code, int size) { @@ -719,8 +731,8 @@ cleanup_and_fail: /** * mono_debug_il_offset_from_address: * - * Compute the IL offset corresponding to NATIVE_OFFSET inside the native - * code of METHOD in DOMAIN. + * Compute the IL offset corresponding to \p native_offset inside the native + * code of \p method in \p domain. */ gint32 mono_debug_il_offset_from_address (MonoMethod *method, MonoDomain *domain, guint32 native_offset) @@ -743,7 +755,7 @@ mono_debug_il_offset_from_address (MonoMethod *method, MonoDomain *domain, guint * native offset \p address within \p method. * The returned \c MonoDebugSourceLocation contains both file / line number * information and the corresponding IL offset. It must be freed by - * mono_debug_free_source_location(). + * \c mono_debug_free_source_location. */ MonoDebugSourceLocation * mono_debug_lookup_source_location (MonoMethod *method, guint32 address, MonoDomain *domain) @@ -918,7 +930,7 @@ mono_install_get_seq_point (MonoGetSeqPointFunc func) /** * mono_debug_print_stack_frame: * \param native_offset Native offset within the \p method's machine code. - * Conventient wrapper around mono_debug_lookup_source_location() which can be + * Conventient wrapper around \c mono_debug_lookup_source_location which can be * used if you only want to use the location to print a stack frame. */ gchar * -- 2.25.1