Some more, incomplete documentation.

glynos · glynos · commit 3d0cc9212086 · 2013-09-23T19:41:17.000+02:00
diff --git a/http/src/network/http/v2/client/client.hpp b/http/src/network/http/v2/client/client.hpp
@@ -228,7 +228,8 @@ namespace network {
       /**
        * \ingroup http_client
        * \class client network/http/v2/client/client.hpp
-       * \brief An HTTP client.
+       * \brief A class that encapsulates the operations and methods
+       *        for communicating with an HTTP servier.
        */
       class client {
 
diff --git a/http/src/network/http/v2/client/response.hpp b/http/src/network/http/v2/client/response.hpp
@@ -20,17 +20,46 @@
 namespace network {
   namespace http {
     namespace v2 {
+      /**
+       * \ingroup http_client
+       * \class response network/http/v2/client/response.hpp
+       * \brief A class that encapsulates an HTTP response.
+       */
       class response {
 
       public:
 
+        /**
+         * \typedef string_type
+         * \brief The responses string_type.
+         */
 	typedef std::string string_type;
+
+        /**
+         * \typedef headers_type
+         * \brief
+         */
 	typedef std::vector<std::pair<string_type, string_type>> headers_type;
+
+        /**
+         * \typedef headers_iterator
+         */
 	typedef headers_type::iterator headers_iterator;
+
+        /**
+         * \typedef const_headers_iterator
+         */
 	typedef headers_type::const_iterator const_headers_iterator;
 
+        /**
+         * \brief Constructor.
+         */
 	response() { }
 
+        /**
+         * \brief Copy constructor.
+         * \param other The other response object.
+         */
 	response(const response &other)
 	  : status_(other.status_)
 	  , version_(other.version_)
@@ -39,6 +68,10 @@ namespace network {
 
 	}
 
+        /**
+         * \brief Move constructor.
+         * \param other The other response object.
+         */
 	response(response &&other) noexcept
 	  : status_(std::move(other.status_))
 	  , version_(std::move(other.version_))
@@ -47,26 +80,45 @@ namespace network {
 
 	}
 
+        /**
+         * \brief Assignment operator.
+         * \param other The other response object.
+         */
 	response &operator= (response other) {
 	  other.swap(*this);
 	  return *this;
 	}
 
+        /**
+         * \brief Swap function.
+         * \param other The other response object.
+         */
 	void swap(response &other) noexcept {
 	  std::swap(status_, other.status_);
 	  std::swap(version_, other.version_);
 	  std::swap(status_message_, other.status_message_);
 	  std::swap(headers_, other.headers_);
 	}
 
+        /**
+         * \brief Returns the HTTP response status.
+         * \returns The status code.
+         */
 	std::uint16_t status() const {
 	  return status_;
 	}
 
+        /**
+         * \brief Returns the HTTP response status message.
+         * \returns The status message.
+         */
 	string_type status_message() const {
 	  return status_message_;
 	}
 
+        /**
+         * \brief
+         */
 	boost::iterator_range<const_headers_iterator> headers() const {
 	  return boost::make_iterator_range(std::begin(headers_), std::end(headers_));
 	}
@@ -81,6 +133,10 @@ namespace network {
 	// append_body
 	// get_body
 
+        /**
+         * \brief Returns the HTTP version.
+         * \returns The HTTP version.
+         */
 	string_type version() const {
 	  return version_;
 	}
