[gentoo-commits] proj/libbash:master commit in: src/core/

[Petteri Räty]

commit:     fd5fae5995f7ff66358268bb0dd15a072f4a6f57
Author:     Mu Qiao <qiaomuf <AT> gentoo <DOT> org>
AuthorDate: Thu Aug  4 07:58:16 2011 +0000
Commit:     Petteri Räty <betelgeuse <AT> gentoo <DOT> org>
CommitDate: Thu Aug  4 14:15:15 2011 +0000
URL:        http://git.overlays.gentoo.org/gitweb/?p=proj/libbash.git;a=commit;h=fd5fae59

Doc: reduce doxygen warnings

---
 src/core/bash_ast.h    |    1 +
 src/core/interpreter.h |   13 +++++++------
 src/core/symbols.hpp   |    2 +-
 3 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/src/core/bash_ast.h b/src/core/bash_ast.h
index dd85ae8..50ca7a6 100644
--- a/src/core/bash_ast.h
+++ b/src/core/bash_ast.h
@@ -117,6 +117,7 @@ public:
 
   /// \brief the functor for parser builtin_variable_definitions rule
   /// \param parser the pointer to the parser
+  /// \param local whether to define the variables in local scope
   static pANTLR3_BASE_TREE parser_builtin_variable_definitions(libbashParser_Ctx_struct* parser, bool local);
 
   ///

diff --git a/src/core/interpreter.h b/src/core/interpreter.h
index 091d4b7..fcc3294 100644
--- a/src/core/interpreter.h
+++ b/src/core/interpreter.h
@@ -76,8 +76,8 @@ class interpreter: public boost::noncopyable
 
   /// \brief calculate the correct offset when offset < 0 and check whether
   ///        the real offset is in legal range
-  /// \param[in,out] a value/result argument referring to offset
-  /// \param[in] the original string
+  /// \param[in,out] offset a value/result argument referring to offset
+  /// \param[in] size the size of the original string
   /// \return whether the real offset is in legal range
   bool get_real_offset(long long& offset, const unsigned size) const
   {
@@ -368,6 +368,7 @@ public:
   }
 
   /// \brief perform ${parameter:−word} expansion
+  /// \param cond whether to perform expansion
   /// \param name the name of the parameter
   /// \param value the value of the word
   /// \param index the index of the paramter
@@ -381,6 +382,7 @@ public:
   }
 
   /// \brief perform ${parameter:=word} expansion
+  /// \param cond whether to perform expansion
   /// \param name the name of the parameter
   /// \param value the value of the word
   /// \param index the index of the paramter
@@ -394,9 +396,8 @@ public:
   }
 
   /// \brief perform ${parameter:+word} expansion
-  /// \param name the name of the parameter
+  /// \param cond whether to perform expansion
   /// \param value the value of the word
-  /// \param index the index of the paramter
   /// \return the expansion result
   const std::string do_alternate_expansion(bool cond,
                                            const std::string& value) const
@@ -472,7 +473,7 @@ public:
 
   /// \brief implementation of word splitting
   /// \param word the value of the word
-  //. \param[out] output the splitted result will be appended to output
+  ///.\param[out] output the splitted result will be appended to output
   void split_word(const std::string& word, std::vector<std::string>& output) const;
 
   /// \brief get the status of shell optional behavior
@@ -507,7 +508,7 @@ public:
   long eval_arithmetic(const std::string& expression);
 
   /// \brief shift the positional parameters to the left by n.
-  /// \param the number to be shifted
+  /// \param shift_number the number to be shifted
   /// \return zero unless n is greater than $# or less than zero, non-zero otherwise.
   int shift(int shift_number);
 

diff --git a/src/core/symbols.hpp b/src/core/symbols.hpp
index 15a3fa0..8dd8cd3 100644
--- a/src/core/symbols.hpp
+++ b/src/core/symbols.hpp
@@ -267,7 +267,7 @@ public:
 
 /// \brief the specialized constructor for arrays
 /// \param name the variable name
-/// \param value the variable value
+/// \param v the variable value
 /// \param ro whether the variable readonly
 template <>
 inline variable::variable<>(const std::string& name,