commit 770827cdebfa2eef2fca242374e2660f98eb7b6f
author Alexander Afanasyev <alexander.afanasyev@ucla.edu> Tue May 13 17:42:55 2014 -0700
committer Alexander Afanasyev <alexander.afanasyev@ucla.edu> Thu May 15 23:04:02 2014 -0700
tree 4ed514e16fbab9d02e3cc81c2a560c7c12c6cd39
parent fc7d33a98ef48da679a5cec0d0c44767ec137053

docs: Updating doxygen comments and minor update to normalize API

Change-Id: I24686acc36f372ee2eddffaaa6c104f964ceeca4
Refs: #1299

src/security/key-chain.hpp

diff --git a/src/security/key-chain.hpp b/src/security/key-chain.hpp
index db71884..30efa12 100644
--- a/src/security/key-chain.hpp
+++ b/src/security/key-chain.hpp
@@ -102,7 +102,7 @@
   /**
    * @brief prepare an unsigned identity certificate
    *
-   * @param keyName Key name, e.g., /<identity_name>/ksk-123456.
+   * @param keyName Key name, e.g., `/<identity_name>/ksk-123456`.
    * @param signingIdentity The signing identity.
    * @param notBefore Refer to IdentityCertificate.
    * @param notAfter Refer to IdentityCertificate.
@@ -177,9 +177,7 @@
   signByIdentity(const uint8_t* buffer, size_t bufferLength, const Name& identityName);
 
   /**
-   * @brief Set Sha256 weak signature.
-   *
-   * @param data.
+   * @brief Set Sha256 weak signature for @param data
    */
   inline void
   signWithSha256(Data& data);
@@ -187,8 +185,8 @@
   /**
    * @brief Generate a self-signed certificate for a public key.
    *
-   * @param keyName The name of the public key.
-   * @return The generated certificate, NULL if selfSign fails.
+   * @param keyName The name of the public key
+   * @return The generated certificate, shared_ptr<IdentityCertificate>() if selfSign fails
    */
   shared_ptr<IdentityCertificate>
   selfSign(const Name& keyName);