[nemiver/better-variable-format: 2/4] Style/comments cleanups

[Dodji Seketeli <dodji src gnome org>]

commit 7223f016476793887e4c32e1b5117c554f193e2f
Author: Dodji Seketeli <dodji gnome org>
Date:   Mon Aug 30 11:20:00 2010 +0200

    Style/comments cleanups
    
    	* src/dbgengine/nmv-debugger-utils.cc (gen_white_spaces)
    	(dump_variable_value): Add comment for these functions.
    	* src/dbgengine/nmv-gdb-engine.cc (struct
    	OnListChangedVariableHandler): Tiny style cleanup.
    	(do_init): Fix comment.
    	* src/dbgengine/nmv-gdbmi-parser.h (parse_stack_arguments):
    	Tiny style cleanup.

 src/dbgengine/nmv-debugger-utils.cc |   15 +++++++++++++++
 src/dbgengine/nmv-gdb-engine.cc     |    9 +++++----
 src/dbgengine/nmv-gdbmi-parser.h    |    8 ++++----
 3 files changed, 24 insertions(+), 8 deletions(-)
---
diff --git a/src/dbgengine/nmv-debugger-utils.cc b/src/dbgengine/nmv-debugger-utils.cc
index 14d43f4..b6214a8 100644
--- a/src/dbgengine/nmv-debugger-utils.cc
+++ b/src/dbgengine/nmv-debugger-utils.cc
@@ -29,6 +29,10 @@
 NEMIVER_BEGIN_NAMESPACE (nemiver)
 NEMIVER_BEGIN_NAMESPACE (debugger_utils)
 
+/// Generate a string of of white spaces.
+/// \param a_nb_ws the number of white spaces to generate
+/// \param a_ws_str the output string the white spaces are
+///  generated into.
 void
 gen_white_spaces (int a_nb_ws,
                   std::string &a_ws_str)
@@ -40,6 +44,12 @@ gen_white_spaces (int a_nb_ws,
     }
 }
 
+/// Serialize a variable and its value into an output stream.
+/// \param a_var the variable to serialize.
+/// \param a_indent_num the number of spaces to indent to before
+/// serializing the variable.
+/// \param a_os the output stream to serialize into.
+/// \param a_print_var_name if true, serialize the variable name too.
 void
 dump_variable_value (IDebugger::VariableSafePtr a_var,
                      int a_indent_num,
@@ -75,6 +85,11 @@ dump_variable_value (IDebugger::VariableSafePtr a_var,
     }
 }
 
+/// Serialize a variable and its value into a string.
+/// \param a_var the variable to serialize.
+/// \param a_indent_num the number of spaces to indent to before
+/// serializing the variable.
+/// \param a_out_str the string to serialize the variable into.
 void
 dump_variable_value (IDebugger::VariableSafePtr a_var,
                      int a_indent_num,
diff --git a/src/dbgengine/nmv-gdb-engine.cc b/src/dbgengine/nmv-gdb-engine.cc
index 8420e9b..f38e477 100644
--- a/src/dbgengine/nmv-gdb-engine.cc
+++ b/src/dbgengine/nmv-gdb-engine.cc
@@ -2510,7 +2510,8 @@ struct OnUnfoldVariableHandler : public OutputHandler {
     }
 };// End struct OnUnfoldVariableHandler
 
-struct OnListChangedVariableHandler : public OutputHandler {
+struct OnListChangedVariableHandler : public OutputHandler
+{
     GDBEngine *m_engine;
 
     OnListChangedVariableHandler (GDBEngine *a_engine) :
@@ -3366,9 +3367,9 @@ GDBEngine::init ()
     init_output_handlers ();
 }
 
-// Put here the initialization that must happen once our call call us
-// For initialization, i.e, after we are sure we have stuff like conf
-// manager ready, etc ...
+// Put here the initialization that must happen once we are called
+// for initialization, i.e, after we are sure we have stuff like
+// conf manager ready, etc ...
 void
 GDBEngine::do_init (IConfMgrSafePtr a_conf_mgr)
 {
diff --git a/src/dbgengine/nmv-gdbmi-parser.h b/src/dbgengine/nmv-gdbmi-parser.h
index c9c2ae4..3b2d0ea 100644
--- a/src/dbgengine/nmv-gdbmi-parser.h
+++ b/src/dbgengine/nmv-gdbmi-parser.h
@@ -565,10 +565,10 @@ public:
     /// GDB/MI command -stack-list-arguments 1.
     /// It is basically the arguments of the functions of the call stack.
     /// See the GDB/MI documentation for more.
-    bool parse_stack_arguments (UString::size_type a_from,
-                                UString::size_type &a_to,
-                                map<int,
-                                    list<IDebugger::VariableSafePtr> > &a_parms);
+    bool parse_stack_arguments
+                        (UString::size_type a_from,
+                         UString::size_type &a_to,
+                         map<int, list<IDebugger::VariableSafePtr> > &a_params);
 
     /// parse a list of local variables as returned by
     /// the GDBMI command -stack-list-locals 2