From e21ac3a33cde261736529fed8a1f34b2a1aaf236 Mon Sep 17 00:00:00 2001
From: lloyd <lloyd@randombit.net>
Date: Mon, 13 Oct 2008 20:19:14 +0000
Subject: Add InSiTo Doxygen comments for freestore.h

---
 src/cert/cvc/freestore.h | 44 ++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 40 insertions(+), 4 deletions(-)

diff --git a/src/cert/cvc/freestore.h b/src/cert/cvc/freestore.h
index abcd1e3ae..e33c0f094 100644
--- a/src/cert/cvc/freestore.h
+++ b/src/cert/cvc/freestore.h
@@ -18,24 +18,60 @@
 
 namespace Botan {
 
+/**
+* This class is intended as an function call parameter type and
+* enables convenient automatic conversions between plain and smart
+* pointer types. It internally stores a SharedPointer which can be
+* accessed.
+*/
 template<typename T>
 class BOTAN_DLL SharedPtrConverter
    {
    public:
       typedef std::tr1::shared_ptr<T> SharedPtr;
 
-      SharedPtrConverter() : ptr() {};
-      SharedPtrConverter(SharedPtrConverter const& other)
-         : ptr(other.ptr) {};
+      /**
+      * Construct a null pointer equivalent object.
+      */
+      SharedPtrConverter() : ptr() {}
 
+      /**
+      * Copy constructor.
+      */
+      SharedPtrConverter(SharedPtrConverter const& other) :
+         ptr(other.ptr) {}
+
+      /**
+      * Construct a converter object from another pointer type.
+      * @param p the pointer which shall be set as the internally stored
+      * pointer value of this converter.
+      */
       template<typename Ptr>
       SharedPtrConverter(Ptr p)
-         : ptr(p) {};
+         : ptr(p) {}
 
+      /**
+      * Get the internally stored shared pointer.
+      * @return the internally stored shared pointer
+      */
       SharedPtr const& get_ptr() const { return this->ptr; }
+
+      /**
+      * Get the internally stored shared pointer.
+      * @return the internally stored shared pointer
+      */
       SharedPtr get_ptr() { return this->ptr; }
 
+      /**
+      * Get the internally stored shared pointer.
+      * @return the internally stored shared pointer
+      */
       SharedPtr const& get_shared() const { return this->ptr; }
+
+      /**
+      * Get the internally stored shared pointer.
+      * @return the internally stored shared pointer
+      */
       SharedPtr get_shared() { return this->ptr; }
 
    private:
-- 
cgit v1.2.3