From: Michal 'vorner' Vaner <michal.vaner@nic.cz>
Date: Mon, 4 Jul 2011 11:54:49 +0000 (+0200)
Subject: [trac981] Doxygen documentation
X-Git-Tag: perftcpdns_before_epoll~263^2~1^2~1^2~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2ab154b25ceb6264f87ba6a3ca139ec44c7db275;p=thirdparty%2Fkea.git

[trac981] Doxygen documentation
---

diff --git a/src/lib/acl/logic_check.h b/src/lib/acl/logic_check.h
index f9fbec2e8c..cf511baea5 100644
--- a/src/lib/acl/logic_check.h
+++ b/src/lib/acl/logic_check.h
@@ -200,21 +200,39 @@ private:
     const std::string name_;
 };
 
+/**
+ * \brief The NOT operator for ACLs.
+ *
+ * This simply returns the negation of whatever returns the subexpression.
+ */
 template<typename Context>
 class NotCheck : public CompoundCheck<Context> {
 public:
+    /**
+     * \brief Constructor
+     *
+     * \param expr The subexpression to be negated by this NOT.
+     */
     NotCheck(const boost::shared_ptr<Check<Context> >& expr) :
         expr_(expr)
     { }
+    /**
+     * \brief The list of subexpressions
+     *
+     * \return The vector will contain single value and it is the expression
+     *     passed by constructor.
+     */
     virtual typename CompoundCheck<Context>::Checks getSubexpressions() const {
         typename CompoundCheck<Context>::Checks result;
         result.push_back(expr_.get());
         return (result);
     }
+    /// \brief The matching function
     virtual bool matches(const Context& context) const {
         return (!expr_->matches(context));
     }
 private:
+    /// \brief The subexpression
     const boost::shared_ptr<Check<Context> > expr_;
 };