Minor fixes to C++ documentation.

PiperOrigin-RevId: 198841818 GitOrigin-RevId: 9d6b3859e704b9b781b6312f30c900e8c98ffcda
sixh · Jun 6, 2018 · 85ca63f · 85ca63f
1 parent d0b2367
commit 85ca63f
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/cc/keyset_reader.h b/cc/keyset_reader.h
@@ -23,13 +23,16 @@
 namespace crypto {
 namespace tink {
 
-// KeysetReader
+// KeysetReader knows how to read a Keyset or an EncryptedKeyset
+// from some source.
 class KeysetReader {
  public:
+  // Reads and returns a (cleartext) Keyset object from the underlying source.
   virtual crypto::tink::util::StatusOr<
    std::unique_ptr<google::crypto::tink::Keyset>>
   Read() = 0;
 
+  // Reads and returns an EncryptedKeyset object from the underlying source.
   virtual crypto::tink::util::StatusOr<
     std::unique_ptr<google::crypto::tink::EncryptedKeyset>>
   ReadEncrypted() = 0;

diff --git a/cc/keyset_writer.h b/cc/keyset_writer.h
@@ -23,12 +23,15 @@
 namespace crypto {
 namespace tink {
 
-// KeysetWriter
+// KeysetWriter knows how to write a Keyset or an EncryptedKeyset
+// to some storage system.
 class KeysetWriter {
  public:
+  // Writes 'keyset' to the underlying storage system.
   virtual crypto::tink::util::Status
       Write(const google::crypto::tink::Keyset& keyset) = 0;
 
+  // Writes 'encrypted_keyset' to the underlying storage system.
   virtual crypto::tink::util::Status
       Write(const google::crypto::tink::EncryptedKeyset& encrypted_keyset) = 0;
 

diff --git a/examples/helloworld/cc/README.md b/examples/helloworld/cc/README.md
@@ -23,7 +23,7 @@ echo "some plaintext" > foo.txt
     encrypt foo.txt "some aad" bar.encrypted
 ./bazel-bin/examples/helloworld/cc/hello_world ./examples/helloworld/cc/aes128_gcm_test_keyset_json.txt\
     decrypt bar.encrypted "some aad" foo-decrypted.txt
-cat foo2.txt
+cat foo-decrypted.txt
 ```
 
 TODO: copy this app to