Added doxygen documentation for error handling.

glynos · glynos · commit d04307288a5e · 2013-12-02T20:58:58.000+01:00
diff --git a/Doxyfile.in b/Doxyfile.in
@@ -648,8 +648,9 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/http/src/network/http/v2/ \
-                         @CMAKE_CURRENT_SOURCE_DIR@/uri/src/network/
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/error/ \
+                         @CMAKE_CURRENT_SOURCE_DIR@/uri/src/network/ \
+                         @CMAKE_CURRENT_SOURCE_DIR@/http/src/network/http/v2/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
diff --git a/error/src/network/error.hpp b/error/src/network/error.hpp
@@ -7,6 +7,8 @@
 #define NETWORK_ERROR_INC
 
 /**
+ * \defgroup error Generic Error Handling
+ *
  * \file
  * \brief Contains a set of error classes and exceptions for
  *        network connections.
@@ -16,7 +18,14 @@
 
 namespace network {
   /**
+   * \ingroup error
    * \brief Gets the error category for network errors.
+   *
+   * e.g.
+   *
+   * \code
+   * throw std::system_error(EPIPE, network::network_category());
+   * \endcode
    */
   const std::error_category &network_category();
 } // namespace network
