propagate from branch 'net.randombit.botan' (head 294e2082ce9231d6165276e2f2a4153a0116aca3)

            to branch 'net.randombit.botan.c++0x' (head 0b695fad10f924601e07b009fcd781191fafcb28)

1 files changed, 5 insertions, 4 deletions

diff --git a/src/s2k/s2k.h b/src/s2k/s2k.h
index db59a5fe8..d6880db5d 100644
--- a/src/s2k/s2k.h
+++ b/src/s2k/s2k.h
@@ -12,21 +12,22 @@
 
 namespace Botan {
 
-/*
-* S2K Interface
+/**
+* Base class for S2K (string to key) operations, which convert a
+* password/passphrase into a key
 */
 class BOTAN_DLL S2K
    {
    public:
 
       /**
-      * @return a new instance of this same algorithm
+      * @return new instance of this same algorithm
       */
       virtual S2K* clone() const = 0;
 
       /**
       * Get the algorithm name.
-      * @return the name of this S2K algorithm
+      * @return name of this S2K algorithm
       */
       virtual std::string name() const = 0;