Commitd043072

committed

Added doxygen documentation for error handling.

1 parentd68fb57 commitd043072Copy full SHA for d043072

File tree

+12

-2

lines changed

+12

-2

lines changed

Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -648,8 +648,9 @@ WARN_LOGFILE =`
`648`	`648`	`# directories like "/usr/src/myproject". Separate the files or directories`
`649`	`649`	`# with spaces.`
`650`	`650`
`651`		`-INPUT = @CMAKE_CURRENT_SOURCE_DIR@/http/src/network/http/v2/ \`
`652`		`- @CMAKE_CURRENT_SOURCE_DIR@/uri/src/network/`
	`651`	`+INPUT = @CMAKE_CURRENT_SOURCE_DIR@/error/ \`
	`652`	`+ @CMAKE_CURRENT_SOURCE_DIR@/uri/src/network/ \`
	`653`	`+ @CMAKE_CURRENT_SOURCE_DIR@/http/src/network/http/v2/`
`653`	`654`
`654`	`655`	`# This tag can be used to specify the character encoding of the source files`
`655`	`656`	`# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is`

Lines changed: 9 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,8 @@`
`7`	`7`	`#defineNETWORK_ERROR_INC`
`8`	`8`
`9`	`9`	`/**`
	`10`	`+ * \defgroup error Generic Error Handling`
	`11`	`+ *`
`10`	`12`	`* \file`
`11`	`13`	`* \brief Contains a set of error classes and exceptions for`
`12`	`14`	`* network connections.`
`@@ -16,7 +18,14 @@`
`16`	`18`
`17`	`19`	`namespacenetwork {`
`18`	`20`	`/**`
	`21`	`+ * \ingroup error`
`19`	`22`	`* \brief Gets the error category for network errors.`
	`23`	`+ *`
	`24`	`+ * e.g.`
	`25`	`+ *`
	`26`	`+ * \code`
	`27`	`+ * throw std::system_error(EPIPE, network::network_category());`
	`28`	`+ * \endcode`
`20`	`29`	`*/`
`21`	`30`	`const std::error_category &network_category();`
`22`	`31`	`}// namespace network`

Comments

(0)