]> git.saurik.com Git - apt.git/blobdiff - apt-pkg/contrib/error.h
drop confusing comma from no strong hash message
[apt.git] / apt-pkg / contrib / error.h
index 919b1e6d49d9e38181d5e68cd984e8561971be73..80d731ac96953770f680d75c67ace6ee5dafee81 100644 (file)
@@ -141,14 +141,14 @@ public:                                                                   /*{{{*/
         */
        bool InsertErrno(MsgType type, const char* Function,
                         const char* Description, va_list &args,
-                        int const errsv, size_t &msgSize);
+                        int const errsv, size_t &msgSize) APT_COLD;
 
        /** \brief add an fatal error message to the list
         *
         *  Most of the stuff we consider as "error" is also "fatal" for
         *  the user as the application will not have the expected result,
         *  but a fatal message here means that it gets printed directly
-        *  to stderr in addiction to adding it to the list as the error
+        *  to stderr in addition to adding it to the list as the error
         *  leads sometimes to crashes and a maybe duplicated message
         *  is better than "Segfault" as the only displayed text
         *
@@ -225,19 +225,19 @@ public:                                                                   /*{{{*/
         *
         *  \return \b true if an error is included in the list, \b false otherwise
         */
-       inline bool PendingError() const {return PendingFlag;};
+       inline bool PendingError() const APT_PURE {return PendingFlag;};
 
        /** \brief is the list empty?
         *
-        *  The default checks if the list is empty or contains only notices,
-        *  if you want to check if also no notices happened set the parameter
-        *  flag to \b false.
+        *  Can be used to check if the current stack level doesn't include
+        *  anything equal or more severe than a given threshold, defaulting
+        *  to warning level for historic reasons.
         *
-        *  \param threshold minimim level considered
+        *  \param threshold minimum level considered
         *
-        *  \return \b true if an the list is empty, \b false otherwise
+        *  \return \b true if the list is empty, \b false otherwise
         */
-       bool empty(MsgType const &threshold = WARNING) const;
+       bool empty(MsgType const &threshold = WARNING) const APT_PURE;
 
        /** \brief returns and removes the first (or last) message in the list
         *
@@ -252,12 +252,11 @@ public:                                                                   /*{{{*/
 
        /** \brief outputs the list of messages to the given stream
         *
-        *  Note that all messages are discarded, also the notices
-        *  displayed or not.
+        *  Note that all messages are discarded, even undisplayed ones.
         *
         *  \param[out] out output stream to write the messages in
-        *  \param threshold minimim level considered
-         *  \param mergeStack 
+        *  \param threshold minimum level considered
+        *  \param mergeStack if true recursively dumps the entire stack
         */
        void DumpErrors(std::ostream &out, MsgType const &threshold = WARNING,
                        bool const &mergeStack = true);
@@ -303,7 +302,7 @@ public:                                                                     /*{{{*/
        void MergeWithStack();
 
        /** \brief return the deep of the stack */
-       size_t StackCount() const {
+       size_t StackCount() const APT_PURE {
                return Stacks.size();
        }
 
@@ -333,7 +332,7 @@ private:                                                            /*{{{*/
        bool PendingFlag;
 
        struct MsgStack {
-               std::list<Item> const Messages;
+               std::list<Item> Messages;
                bool const PendingFlag;
 
                MsgStack(std::list<Item> const &Messages, bool const &Pending) :