From 437c149416710088a36de8227b296a75e8313074 Mon Sep 17 00:00:00 2001 From: Matthias Wachs Date: Thu, 23 Dec 2010 09:40:16 +0000 Subject: [PATCH] doxygen --- src/dht/gnunet-service-dht.c | 3 +++ src/fs/fs_download.c | 1 + src/include/gnunet_monkey_edb.h | 3 +-- src/monkey/edb_api.c | 3 +-- src/monkey/gdbmi_alloc.c | 2 +- src/monkey/gdbmi_breakpoint.c | 6 +++--- src/monkey/gdbmi_connect.c | 11 ++++++----- src/monkey/gdbmi_data_man.c | 8 +++++--- src/monkey/gdbmi_get_free_pty.c | 2 +- src/monkey/gdbmi_misc.c | 2 +- src/monkey/gdbmi_prg_control.c | 4 ++-- src/monkey/gdbmi_stack_man.c | 12 ++++++------ src/monkey/gdbmi_target_man.c | 2 +- src/monkey/gdbmi_thread.c | 2 +- src/monkey/gdbmi_var_obj.c | 18 ++++++++++-------- src/monkey/seaspider/SeaspiderTest.c | 2 +- 16 files changed, 44 insertions(+), 37 deletions(-) diff --git a/src/dht/gnunet-service-dht.c b/src/dht/gnunet-service-dht.c index cbcc88e80..1bf6613e7 100644 --- a/src/dht/gnunet-service-dht.c +++ b/src/dht/gnunet-service-dht.c @@ -1951,6 +1951,7 @@ add_pending_message (struct ClientList *client, * @param client the client to send the reply to * @param message the encapsulated message to send * @param uid the unique identifier of this request + * @param key key */ static void send_reply_to_client (struct ClientList *client, @@ -4602,6 +4603,7 @@ handle_dht_local_route_stop (void *cls, struct GNUNET_SERVER_Client *client, * Core handler for p2p route requests. * * @param cls closure + * @param message message * @param peer peer identity this notification is about * @param atsi performance data * @@ -4705,6 +4707,7 @@ handle_dht_p2p_route_request (void *cls, * Core handler for p2p route results. * * @param cls closure + * @param message message * @param peer peer identity this notification is about * @param atsi performance data * diff --git a/src/fs/fs_download.c b/src/fs/fs_download.c index d7693a93f..746303c69 100644 --- a/src/fs/fs_download.c +++ b/src/fs/fs_download.c @@ -534,6 +534,7 @@ get_next_block (void *cls, * @param cls closure * @param query the query for the block (key for lookup in the datastore) * @param offset offset of the block + * @param depth depth * @param type type of the block (IBLOCK or DBLOCK) * @param block the (encrypted) block * @param block_size size of block (in bytes) diff --git a/src/include/gnunet_monkey_edb.h b/src/include/gnunet_monkey_edb.h index 30ad7cf43..380ba4ade 100644 --- a/src/include/gnunet_monkey_edb.h +++ b/src/include/gnunet_monkey_edb.h @@ -50,8 +50,7 @@ struct GNUNET_MONKEY_EDB_Context *GNUNET_MONKEY_EDB_connect (const char /** * Disconnect from Database, and cleanup resources * - * @param cfg configuration to use (used to know the path of the .db file). - * @param service service that *this* process is implementing/providing, can be NULL + * @param context context * @return GNUNET_OK on success, GNUNET_NO on failure */ int GNUNET_MONKEY_EDB_disconnect (struct GNUNET_MONKEY_EDB_Context *context); diff --git a/src/monkey/edb_api.c b/src/monkey/edb_api.c index 32fc0bc41..4595731ac 100644 --- a/src/monkey/edb_api.c +++ b/src/monkey/edb_api.c @@ -58,8 +58,7 @@ GNUNET_MONKEY_EDB_connect (const char *db_file_name) /** * Disconnect from Database, and cleanup resources * - * @param cfg configuration to use (used to know the path of the .db file). - * @param service service that *this* process is implementing/providing, can be NULL + * @param context context * @return GNUNET_OK on success, GNUNET_NO on failure */ int diff --git a/src/monkey/gdbmi_alloc.c b/src/monkey/gdbmi_alloc.c index 7fd60921b..0fe6e14de 100644 --- a/src/monkey/gdbmi_alloc.c +++ b/src/monkey/gdbmi_alloc.c @@ -6,7 +6,7 @@ Module: Allocator. Comments: Most alloc/free routines are here. Free routines must accept NULL -pointers. Alloc functions must set mi_error.@p +pointers. Alloc functions must set mi_error. @

***************************************************************************/ diff --git a/src/monkey/gdbmi_breakpoint.c b/src/monkey/gdbmi_breakpoint.c index 07be215c1..f91cc3ea5 100644 --- a/src/monkey/gdbmi_breakpoint.c +++ b/src/monkey/gdbmi_breakpoint.c @@ -5,8 +5,8 @@ Module: Breakpoint table commands. Comments: - GDB/MI commands for the "Breakpoint Table Commands" section.@p - + GDB/MI commands for the "Breakpoint Table Commands" section. + @

@

 gdb command:          Implemented?
 
@@ -22,7 +22,7 @@ gdb command:          Implemented?
 @
(*) I think the program should keep track of the breakpoints, so it will -be implemented when I have more time.@p +be implemented when I have more time. @

***************************************************************************/ diff --git a/src/monkey/gdbmi_connect.c b/src/monkey/gdbmi_connect.c index 7fe9c50f8..c6e73879f 100644 --- a/src/monkey/gdbmi_connect.c +++ b/src/monkey/gdbmi_connect.c @@ -6,7 +6,8 @@ Module: Connect. Comments: This module handles the dialog with gdb, including starting and stopping -gdb.@p +gdb. + @

GDB Bug workaround for "file -readnow": I tried to workaround a bug using it but looks like this option also have bugs!!!! so I have to use the @@ -441,7 +442,7 @@ mi_h *mi_connect_local() /**[txh]******************************************************************** Description: - Close connection. You should ask gdb to quit first @x{gmi_gdb_exit}. + Close connection. You should ask gdb to quit first gmi_gdb_exit. ***************************************************************************/ @@ -705,7 +706,7 @@ const char *mi_get_main_func() Description: Opens a new xterm to be used by the child process to debug. - Return: A new mi_aux_term structure, you can use @x{gmi_end_aux_term} to + Return: A new mi_aux_term structure, you can use gmi_end_aux_term to release it. ***************************************************************************/ @@ -853,7 +854,7 @@ void mi_force_version(mi_h *h, unsigned vMajor, unsigned vMiddle, /**[txh]******************************************************************** Description: - Dis/Enables the @var{wa} workaround for a bug in gdb. + Dis/Enables the workaround for a bug in gdb. ***************************************************************************/ @@ -870,7 +871,7 @@ void mi_set_workaround(unsigned wa, int enable) /**[txh]******************************************************************** Description: - Finds if the @var{wa} workaround for a bug in gdb is enabled. + Finds if the workaround for a bug in gdb is enabled. Return: !=0 if enabled. diff --git a/src/monkey/gdbmi_data_man.c b/src/monkey/gdbmi_data_man.c index a5e54a958..06e137720 100644 --- a/src/monkey/gdbmi_data_man.c +++ b/src/monkey/gdbmi_data_man.c @@ -5,7 +5,9 @@ Module: Data manipulation. Comments: - GDB/MI commands for the "Data manipulation" section.@p + GDB/MI commands for the "Data manipulation" section. + + @

@

 gdb command:                       Implemented?
@@ -26,11 +28,11 @@ gdb command:                       Implemented?
 -environment-path                  No
 @
-Notes:@p +Notes: @

1) -display* aren't implemented. You can use CLI command display, but the results are sent to the console. So it looks like the best is to manually -use -data-evaluate-expression to emulate it.@p +use -data-evaluate-expression to emulate it. @

2) GDB bug mi/1770: Affects gdb<=6.2, when you ask for the names of the registers you get it plus the name of the "pseudo-registers", but if you diff --git a/src/monkey/gdbmi_get_free_pty.c b/src/monkey/gdbmi_get_free_pty.c index 672145b78..47ddbd628 100644 --- a/src/monkey/gdbmi_get_free_pty.c +++ b/src/monkey/gdbmi_get_free_pty.c @@ -86,7 +86,7 @@ int mi_look_for_free_pty(int *master, char **slave) Description: Look for a free and usable pseudo terminal to be used by the child. - Return: A new mi_pty structure, you can use @x{gmi_end_pty} to + Return: A new mi_pty structure, you can use gmi_end_pty to release it. ***************************************************************************/ diff --git a/src/monkey/gdbmi_misc.c b/src/monkey/gdbmi_misc.c index 881bd5b7f..51088a757 100644 --- a/src/monkey/gdbmi_misc.c +++ b/src/monkey/gdbmi_misc.c @@ -5,7 +5,7 @@ Module: Miscellaneous commands. Comments: - GDB/MI commands for the "Miscellaneous Commands" section.@p + GDB/MI commands for the "Miscellaneous Commands" section. @

@

 gdb command:       Implemented?
diff --git a/src/monkey/gdbmi_prg_control.c b/src/monkey/gdbmi_prg_control.c
index 0c824b59c..da37dac21 100644
--- a/src/monkey/gdbmi_prg_control.c
+++ b/src/monkey/gdbmi_prg_control.c
@@ -5,7 +5,7 @@
 
   Module: Program control.
   Comments:
-  GDB/MI commands for the "Program Control" section.@p
+  GDB/MI commands for the "Program Control" section.  @

 
 @
 gdb command:                   Implemented?
@@ -33,7 +33,7 @@ gdb command:                   Implemented?
 @

 
 (*)  gmi_exec_kill implements it, but you should ensure that
-gmi_gdb_set("confirm","off") was called.@p
+gmi_gdb_set("confirm","off") was called.  @

 
 GDB Bug workaround for -file-exec-and-symbols and -file-symbol-file: This
 is complex, but a real bug. When you set a breakpoint you never know the
diff --git a/src/monkey/gdbmi_stack_man.c b/src/monkey/gdbmi_stack_man.c
index 6d6ad0866..977ea5e2e 100644
--- a/src/monkey/gdbmi_stack_man.c
+++ b/src/monkey/gdbmi_stack_man.c
@@ -5,7 +5,7 @@
 
   Module: Stack manipulation.
   Comments:
-  GDB/MI commands for the "Stack Manipulation" section.@p
+  GDB/MI commands for the "Stack Manipulation" section.  @

 
 @
 gdb command:              Implemented?
@@ -84,8 +84,8 @@ mi_frames *gmi_stack_list_frames(mi_h *h)
 /**[txh]********************************************************************
 
   Description: 
-  List of frames. Arguments aren't filled. Only the frames in the @var{from}
- - @var{to} range are returned.
+  List of frames. Arguments aren't filled. Only the frames in the from
+ - to range are returned.
   
   Command: -stack-list-frames
   Return:  A new list of mi_frames or NULL on error.
@@ -101,7 +101,7 @@ mi_frames *gmi_stack_list_frames_r(mi_h *h, int from, int to)
 /**[txh]********************************************************************
 
   Description:
-  List arguments. Only @var{level} and @var{args} filled.
+  List arguments. Only level and args filled.
   
   Command: -stack-list-arguments
   Return:  A new list of mi_frames or NULL on error.
@@ -117,8 +117,8 @@ mi_frames *gmi_stack_list_arguments(mi_h *h, int show)
 /**[txh]********************************************************************
 
   Description:
-  List arguments. Only @var{level} and @var{args} filled. Only for the
-frames in the @var{from} - @var{to} range.
+  List arguments. Only level and args filled. Only for the
+frames in the from - to range.
   
   Command: -stack-list-arguments
   Return:  A new list of mi_frames or NULL on error.
diff --git a/src/monkey/gdbmi_target_man.c b/src/monkey/gdbmi_target_man.c
index 5f0979483..bbb2b9807 100644
--- a/src/monkey/gdbmi_target_man.c
+++ b/src/monkey/gdbmi_target_man.c
@@ -5,7 +5,7 @@
 
   Module: Target manipulation.
   Comments:
-  GDB/MI commands for the "Target Manipulation" section.@p
+  GDB/MI commands for the "Target Manipulation" section.  @

 
 @
 -target-attach                  Yes (implemented using attach)
diff --git a/src/monkey/gdbmi_thread.c b/src/monkey/gdbmi_thread.c
index 2550e0e72..b8fa63d90 100644
--- a/src/monkey/gdbmi_thread.c
+++ b/src/monkey/gdbmi_thread.c
@@ -5,7 +5,7 @@
 
   Module: Thread commands.
   Comments:
-  GDB/MI commands for the "Thread Commands" section.@p
+  GDB/MI commands for the "Thread Commands" section.  @

 
 @
 gdb command:              Implemented?
diff --git a/src/monkey/gdbmi_var_obj.c b/src/monkey/gdbmi_var_obj.c
index d3829dbd2..435feecb7 100644
--- a/src/monkey/gdbmi_var_obj.c
+++ b/src/monkey/gdbmi_var_obj.c
@@ -5,7 +5,8 @@
 
   Module: Variable objects.
   Comments:
-  GDB/MI commands for the "Variable Objects" section.@p
+  GDB/MI commands for the "Variable Objects" section.
+    @

 
 @
 gdb command:              Imp? Description:
@@ -23,13 +24,14 @@ gdb command:              Imp? Description:
 -var-update               Yes* update the variable and its children
 @

 
-Notes:@p
+Notes:  @

 1) I suggest letting gdb to choose the names for the variables.@*
 2) -var-list-children supports an optional "show values" argument in MI v2.
 It isn't implemented.@*
-@p
 
-* MI v1 and v2 result formats supported.@p
+  @

+
+* MI v1 and v2 result formats supported.  @

 
 ***************************************************************************/
 
@@ -113,7 +115,7 @@ void mi_var_list_children(mi_h *h, const char *name)
 /**[txh]********************************************************************
 
   Description:
-  Create a variable object. I recommend using @x{gmi_var_create} and letting
+  Create a variable object. I recommend using gmi_var_create and letting
 gdb choose the names.
 
   Command: -var-create
@@ -131,7 +133,7 @@ mi_gvar *gmi_var_create_nm(mi_h *h, const char *name, int frame, const char *exp
 
   Description:
   Create a variable object. The name is selected by gdb. Alternative:
-@x{gmi_full_var_create}.
+  gmi_full_var_create.
 
   Command: -var-create [auto name]
   Return: A new mi_gvar strcture or NULL on error.
@@ -292,7 +294,7 @@ mi_gvar *gmi_full_var_create(mi_h *h, int frame, const char *exp)
 updated.
 
   Command: -var-update
-  Return: !=0 OK. The @var{changed} list contains the list of changed vars.
+  Return: !=0 OK. The changed list contains the list of changed vars.
   
 ***************************************************************************/
 
@@ -305,7 +307,7 @@ int gmi_var_update(mi_h *h, mi_gvar *var, mi_gvar_chg **changed)
 /**[txh]********************************************************************
 
   Description:
-  Change variable. The new value replaces the @var{value} field.
+  Change variable. The new value replaces the value field.
 
   Command: -var-assign
   Return: !=0 OK
diff --git a/src/monkey/seaspider/SeaspiderTest.c b/src/monkey/seaspider/SeaspiderTest.c
index 09e6e4710..d09eae38f 100644
--- a/src/monkey/seaspider/SeaspiderTest.c
+++ b/src/monkey/seaspider/SeaspiderTest.c
@@ -1,5 +1,5 @@
 /**
- * @file seaspider/SeaspiderTest.c
+ * @file src/monkey/seaspider/SeaspiderTest.c
  * @brief C file to test Seaspider's parsing
  */
 
-- 
2.25.1