From 12be8a62d1abb9253a4695badbf70e7210f9b0d2 Mon Sep 17 00:00:00 2001
From: Michael Vogt <michael.vogt@ubuntu.com>
Date: Thu, 29 Jul 2010 14:37:36 +0200
Subject: * apt-pkg/contrib/error.{cc,h}   - docstring cleanup

---
 apt-pkg/contrib/error.cc |  4 ++--
 apt-pkg/contrib/error.h  | 11 ++++++-----
 2 files changed, 8 insertions(+), 7 deletions(-)

(limited to 'apt-pkg')

diff --git a/apt-pkg/contrib/error.cc b/apt-pkg/contrib/error.cc
index fbb6e4636..d63b06d13 100644
--- a/apt-pkg/contrib/error.cc
+++ b/apt-pkg/contrib/error.cc
@@ -180,7 +180,7 @@ bool GlobalError::PopMessage(std::string &Text) {
 }
 									/*}}}*/
 // GlobalError::DumpErrors - Dump all of the errors/warns to cerr	/*{{{*/
-void GlobalError::DumpErrors(std::ostream &out, MsgType const &trashhold,
+void GlobalError::DumpErrors(std::ostream &out, MsgType const &threshold,
 			     bool const &mergeStack) {
 	if (mergeStack == true)
 		for (std::list<MsgStack>::const_reverse_iterator s = Stacks.rbegin();
@@ -189,7 +189,7 @@ void GlobalError::DumpErrors(std::ostream &out, MsgType const &trashhold,
 
 	for (std::list<Item>::const_iterator m = Messages.begin();
 	     m != Messages.end(); m++)
-		if (m->Type >= trashhold)
+		if (m->Type >= threshold)
 			out << (*m) << std::endl;
 	Discard();
 }
diff --git a/apt-pkg/contrib/error.h b/apt-pkg/contrib/error.h
index e5517c2da..d39500427 100644
--- a/apt-pkg/contrib/error.h
+++ b/apt-pkg/contrib/error.h
@@ -204,9 +204,10 @@ public:									/*{{{*/
 	 *  displayed or not.
 	 *
 	 *  \param[out] out output stream to write the messages in
-	 *  \param WithoutNotice output notices or not
+	 *  \param threshold minimim level considered
+         *  \param mergeStack 
 	 */
-	void DumpErrors(std::ostream &out, MsgType const &trashhold = WARNING,
+	void DumpErrors(std::ostream &out, MsgType const &threshold = WARNING,
 			bool const &mergeStack = true);
 
 	/** \brief dumps the list of messages to std::cerr
@@ -214,10 +215,10 @@ public:									/*{{{*/
 	 *  Note that all messages are discarded, also the notices
 	 *  displayed or not.
 	 *
-	 *  \param WithoutNotice print notices or not
+	 *  \param threshold minimum level printed
 	 */
-	void inline DumpErrors(MsgType const &trashhold = WARNING) {
-		DumpErrors(std::cerr, trashhold);
+	void inline DumpErrors(MsgType const &threshold = WARNING) {
+		DumpErrors(std::cerr, threshold);
 	}
 
 	/** \brief put the current Messages into the stack
-- 
cgit v1.2.3