Various tinkerings.

1 files changed, 31 insertions, 2 deletions

diff --git a/src/ref.h b/src/ref.h
index db39bfb6..c22222cc 100644
--- a/src/ref.h
+++ b/src/ref.h
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/ref.h
+ *  @brief Ref class.
+ */
+
 #ifndef LIBDCP_REF_H
 #define LIBDCP_REF_H
 
@@ -27,24 +31,41 @@
 
 namespace dcp {
 
+/** @class Ref
+ *  @brief A reference to an object which is identified by a universally-unique identifier (UUID).
+ *
+ *  This class is a `pointer' to a thing.  It will always know the
+ *  UUID of the thing, and it may have a shared_ptr to the C++ object
+ *  which represents the thing.
+ *
+ *  If the Ref does not have a shared_ptr it may be given one by
+ *  calling resolve() with a list of objects.  The shared_ptr will be
+ *  set up using any object on the list which has a matching ID.
+ */
 template<class T>
 class Ref
 {
 public:
+	/** Initialise a Ref with an ID but no shared_ptr */
 	Ref (std::string id)
 		: _id (id)
 	{}
 
+	/** Initialise a Ref with a shared_ptr to an object */
 	Ref (boost::shared_ptr<T> object)
 		: _id (object->id ())
 		, _object (object)
 	{}
 
+	/** Set the ID of this Ref */
 	void set_id (std::string id)
 	{
 		_id = id;
 	}
 
+	/** Look through a list of objects and copy a shared_ptr to any object
+	 *  which matches the ID of this one.
+	 */
 	void resolve (std::list<boost::shared_ptr<Object> > objects)
 	{
 		typename std::list<boost::shared_ptr<Object> >::iterator i = objects.begin();
@@ -57,10 +78,14 @@ public:
 		}
 	}
 
+	/** @return the ID of the thing that we are pointing to */
 	std::string id () const {
 		return _id;
 	}
 
+	/** @return a shared_ptr to the thing; an UnresolvedRefError is thrown
+	 *  if the shared_ptr is not known.
+	 */
 	boost::shared_ptr<T> object () const {
 		if (!_object) {
 			throw UnresolvedRefError (_id);
@@ -69,6 +94,9 @@ public:
 		return _object;
 	}
 
+	/** operator-> to access the shared_ptr; an UnresolvedRefError is thrown
+	 *  if the shared_ptr is not known.
+	 */
 	T * operator->() const {
 		if (!_object) {
 			throw UnresolvedRefError (_id);
@@ -77,13 +105,14 @@ public:
 		return _object.get ();
 	}
 
+	/** @return true if a shared_ptr is known for this Ref */
 	bool resolved () const {
 		return _object;
 	}
 
 private:
-	std::string _id;
-	boost::shared_ptr<T> _object;
+	std::string _id;              ///< ID; will always be known
+	boost::shared_ptr<T> _object; ///< shared_ptr to the thing, may be null.
 };
 
 }