Fix minor issues raised by Doxygen and add a few missing doc-comments

README.md

@@ -122,7 +122,7 @@ Required:
 
  - boost 1.54
 
-Later versions of boost (up to 1.57) are also known to work correctly.
+Later versions of boost (up to 1.59) are also known to work correctly.
 
 ## Supported Parsers ##
 

include/valijson/adapters/picojson_adapter.hpp

@@ -188,7 +188,7 @@ public:
      * If an object member with the specified name does not exist, the iterator
      * returned will be the same as the iterator returned by the end() function.
      *
-     * @param   property   property name to search for
+     * @param   propertyName  property name to search for
      */
     PicoJsonObjectMemberIterator find(const std::string &propertyName) const;
 
@@ -539,9 +539,9 @@ public:
      * values, and assumes that two identical iterators will point to the same
      * underlying object.
      *
-     * @param   rhs  iterator to compare against
+     * @param   other  iterator to compare against
      *
-     * @returns true if the iterators are equal, false otherwise.
+     * @returns true   if the iterators are equal, false otherwise.
      */
     bool equal(const PicoJsonArrayValueIterator &other) const
     {
@@ -612,7 +612,7 @@ public:
      * values, and assumes that two identical iterators will point to the same
      * underlying object.
      *
-     * @param   rhs  Iterator to compare with
+     * @param   other  Iterator to compare with
      *
      * @returns true if the underlying iterators are equal, false otherwise
      */

include/valijson/adapters/rapidjson_adapter.hpp

@@ -64,6 +64,7 @@ class GenericRapidJsonArrayValueIterator;
 template<class ValueType = rapidjson::Value>
 class GenericRapidJsonObjectMemberIterator;
 
+/// Container for a property name and an associated RapidJson value
 template<class ValueType = rapidjson::Value>
 class GenericRapidJsonObjectMember :
         public std::pair<std::string, GenericRapidJsonAdapter<ValueType> >
@@ -854,8 +855,8 @@ typedef GenericRapidJsonObjectMemberIterator<> RapidJsonObjectMemberIterator;
 typedef GenericRapidJsonValue<> RapidJsonValue;
 
 /**
- * RapidJson specialisation of the AdapterTraits template struct, used
- * primarily for producing better error messages in tests.
+ * @brief  Specialisation of the AdapterTraits template struct for a
+ *         RapidJsonAdapter that uses a pool allocator
  */
 template<>
 struct AdapterTraits<valijson::adapters::RapidJsonAdapter>
@@ -868,9 +869,15 @@ struct AdapterTraits<valijson::adapters::RapidJsonAdapter>
     }
 };
 
+typedef rapidjson::GenericValue<rapidjson::UTF8<>, rapidjson::CrtAllocator>
+        RapidJsonCrt;
+
+/**
+ * @brief  Specialisation of the AdapterTraits template struct for a
+ *         RapidJsonAdapter that uses the default CRT allocator
+ */
 template<>
-struct AdapterTraits<valijson::adapters::GenericRapidJsonAdapter<
-    rapidjson::GenericValue<rapidjson::UTF8<>, rapidjson::CrtAllocator> > >
+struct AdapterTraits<valijson::adapters::GenericRapidJsonAdapter<RapidJsonCrt> >
 {
     typedef rapidjson::GenericDocument<rapidjson::UTF8<>,
         rapidjson::CrtAllocator> DocumentType;

include/valijson/constraints/constraint_visitor.hpp

@@ -28,6 +28,7 @@ struct RequiredConstraint;
 struct TypeConstraint;
 struct UniqueItemsConstraint;
 
+/// Interface to allow usage of the visitor pattern with Constraints
 class ConstraintVisitor
 {
 protected: