commit 54d74c25a0969d9d452bae85cd9382d309c76bed
author Junxiao Shi <git@mail1.yoursunny.com> Wed Jul 18 07:38:54 2018 -0600
committer Junxiao Shi <git@mail1.yoursunny.com> Wed Jul 18 13:30:08 2018 -0600
tree 8b8c49ee79c2fa9956f4b9c286da12adecd925c0
parent 643b7f5ddf1824fa603c677e0f40eba54a8501d2

security: correct ValidationPolicy docs

refs #4390

Change-Id: I416f8773c9d52e0e7f61edb30d0476f9542fbf2b

src/security/v2/validation-policy.hpp

diff --git a/src/security/v2/validation-policy.hpp b/src/security/v2/validation-policy.hpp
index 20d4f0b..0f86c20 100644
--- a/src/security/v2/validation-policy.hpp
+++ b/src/security/v2/validation-policy.hpp
@@ -22,8 +22,8 @@
 #ifndef NDN_SECURITY_V2_VALIDATION_POLICY_HPP
 #define NDN_SECURITY_V2_VALIDATION_POLICY_HPP
 
-#include "validation-state.hpp"
 #include "certificate-request.hpp"
+#include "validation-state.hpp"
 #include "../../data.hpp"
 #include "../../interest.hpp"
 
@@ -97,10 +97,10 @@
    * Semantics of checkPolicy has changed from v1::Validator
    * - If packet violates policy, the policy should call `state->fail` with appropriate error
    *   code and error description.
-   * - If packet conforms to the policy and no further key retrievals are necessary,
-   *   the policy should call continueValidation(state, nullptr)
-   * - If packet conforms to the policy and a key needs to be fetched, the policy should call
-   *   continueValidation(state, <appropriate-key-request-instance>)
+   * - If packet conforms to the policy and no further certificate retrievals are necessary,
+   *   the policy should call continueValidation(nullptr, state)
+   * - If packet conforms to the policy and a certificate needs to be fetched, the policy should
+   *   call continueValidation(<appropriate-cert-request-instance>, state)
    */
   virtual void
   checkPolicy(const Data& data, const shared_ptr<ValidationState>& state,
@@ -115,10 +115,10 @@
    * Semantics of checkPolicy has changed from v1::Validator
    * - If packet violates policy, the policy should call `state->fail` with appropriate error
    *   code and error description.
-   * - If packet conforms to the policy and no further key retrievals are necessary,
-   *   the policy should call continueValidation(state, nullptr)
-   * - If packet conforms to the policy and a key needs to be fetched, the policy should call
-   *   continueValidation(state, <appropriate-key-request-instance>)
+   * - If packet conforms to the policy and no further certificate retrievals are necessary,
+   *   the policy should call continueValidation(nullptr, state)
+   * - If packet conforms to the policy and a certificate needs to be fetched, the policy should
+   *   call continueValidation(<appropriate-cert-request-instance>, state)
    */
   virtual void
   checkPolicy(const Interest& interest, const shared_ptr<ValidationState>& state,
@@ -135,10 +135,10 @@
    * Semantics of checkPolicy has changed from v1::Validator
    * - If packet violates policy, the policy should call `state->fail` with appropriate error
    *   code and error description.
-   * - If packet conforms to the policy and no further key retrievals are necessary,
-   *   the policy should call continueValidation(state, nullptr)
-   * - If packet conforms to the policy and a key needs to be fetched, the policy should call
-   *   continueValidation(state, <appropriate-key-request-instance>)
+   * - If packet conforms to the policy and no further certificate retrievals are necessary,
+   *   the policy should call continueValidation(nullptr, state)
+   * - If packet conforms to the policy and a certificate needs to be fetched, the policy should
+   *   call continueValidation(<appropriate-cert-request-instance>, state)
    */
   virtual void
   checkPolicy(const Certificate& certificate, const shared_ptr<ValidationState>& state,