Add proper Doxygen comment markings around exception_wrapper example.
authorEric Niebler <eniebler@fb.com>
Tue, 27 Dec 2016 18:45:34 +0000 (10:45 -0800)
committerFacebook Github Bot <facebook-github-bot@users.noreply.github.com>
Tue, 27 Dec 2016 18:48:02 +0000 (10:48 -0800)
Summary: The Doxegen-generated documentation for exception_wrapper is unreadable. The code needs to be denoted with \code...\endcode tags; otherwise, it is formatted like a paragraph and newlines are ignored.

Reviewed By: igorsugak

Differential Revision: D4367636

fbshipit-source-id: 680bedfb152300d8a6287bf441dd9b81b9b94c80

folly/ExceptionWrapper.h

index e4c2e9e0c18cfc4f1af839676ff2866b55c64e9b..1086a8a0b813dec9e99d332bf4633b7ed635f3c9 100644 (file)
@@ -61,8 +61,9 @@ namespace folly {
  * can test or extract a pointer to a specific exception type with very little
  * overhead.
  *
- * Example usage:
- *
+ * \par Example usage:
+ * \par
+ * \code
  * exception_wrapper globalExceptionWrapper;
  *
  * // Thread1
@@ -100,6 +101,7 @@ namespace folly {
  *       }) ||
  *   LOG(FATAL) << "Unrecognized exception";
  * }
+ * \endcode
  *
  */
 class exception_wrapper {