From: Eric Niebler <eniebler@fb.com>
Date: Tue, 27 Dec 2016 18:45:34 +0000 (-0800)
Subject: Add proper Doxygen comment markings around exception_wrapper example.
X-Git-Tag: v2017.03.06.00~160
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=8f0aa1f8836ebb3b6a6e12692ea55e768426964c;p=folly.git

Add proper Doxygen comment markings around exception_wrapper example.

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
---

diff --git a/folly/ExceptionWrapper.h b/folly/ExceptionWrapper.h
index e4c2e9e0..1086a8a0 100644
--- a/folly/ExceptionWrapper.h
+++ b/folly/ExceptionWrapper.h
@@ -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 {