Commit 63dc5615 authored by Curtis Li's avatar Curtis Li Committed by Facebook GitHub Bot

Fix some -Wdocumentation errors

Summary:
Fixes a few documentation errors that get surfaced when compiling with the -Wdocumentation flag.

Full explanation of errors with examples here:
https://clang.llvm.org/docs/DiagnosticsReference.html#wdocumentation

Reviewed By: yfeldblum

Differential Revision: D23119100

fbshipit-source-id: 4e84f624e4d81914b78211af4860540498f8110c
parent 49b1f90b
...@@ -118,7 +118,6 @@ FOLLY_ERASE auto fold(Fn&& fn, A&& a, B&& b, Bs&&... bs) { ...@@ -118,7 +118,6 @@ FOLLY_ERASE auto fold(Fn&& fn, A&& a, B&& b, Bs&&... bs) {
//! little overhead. //! little overhead.
//! //!
//! \par Example usage: //! \par Example usage:
//! \par
//! \code //! \code
//! exception_wrapper globalExceptionWrapper; //! exception_wrapper globalExceptionWrapper;
//! //!
...@@ -540,7 +539,7 @@ class exception_wrapper final { ...@@ -540,7 +539,7 @@ class exception_wrapper final {
//! Throws the wrapped expression nested into another exception. //! Throws the wrapped expression nested into another exception.
//! \pre `bool(*this)` //! \pre `bool(*this)`
//! \tparam ex Exception in *this will be thrown nested into ex; //! \param ex Exception in *this will be thrown nested into ex;
// see std::throw_with_nested() for details on this semantic. // see std::throw_with_nested() for details on this semantic.
template <class Ex> template <class Ex>
[[noreturn]] void throw_with_nested(Ex&& ex) const; [[noreturn]] void throw_with_nested(Ex&& ex) const;
...@@ -601,7 +600,7 @@ class exception_wrapper final { ...@@ -601,7 +600,7 @@ class exception_wrapper final {
//! ew.handle(/*...* /, [](...) { /* handle unknown exception */ } ) //! ew.handle(/*...* /, [](...) { /* handle unknown exception */ } )
//! \endcode //! \endcode
//! \pre `!*this` //! \pre `!*this`
//! \tparam CatchFns... A pack of unary monomorphic function object types. //! \tparam CatchFns A pack of unary monomorphic function object types.
//! \param fns A pack of unary monomorphic function objects to be treated as //! \param fns A pack of unary monomorphic function objects to be treated as
//! an ordered list of potential exception handlers. //! an ordered list of potential exception handlers.
//! \note The handlers may or may not be invoked with an active exception. //! \note The handlers may or may not be invoked with an active exception.
......
...@@ -238,11 +238,11 @@ Container&& as_sorted_unique(Container&& container, Compare const& comp) { ...@@ -238,11 +238,11 @@ Container&& as_sorted_unique(Container&& container, Compare const& comp) {
* A sorted_vector_set is a container similar to std::set<>, but * A sorted_vector_set is a container similar to std::set<>, but
* implemented as a sorted array with std::vector<>. * implemented as a sorted array with std::vector<>.
* *
* @param class T Data type to store * @tparam T Data type to store
* @param class Compare Comparison function that imposes a * @tparam Compare Comparison function that imposes a
* strict weak ordering over instances of T * strict weak ordering over instances of T
* @param class Allocator allocation policy * @tparam Allocator allocation policy
* @param class GrowthPolicy policy object to control growth * @tparam GrowthPolicy policy object to control growth
* *
* @author Aditya Agarwal <aditya@fb.com> * @author Aditya Agarwal <aditya@fb.com>
* @author Akhil Wable <akhil@fb.com> * @author Akhil Wable <akhil@fb.com>
...@@ -758,12 +758,12 @@ using sorted_vector_set = folly::sorted_vector_set< ...@@ -758,12 +758,12 @@ using sorted_vector_set = folly::sorted_vector_set<
* A sorted_vector_map is similar to a sorted_vector_set but stores * A sorted_vector_map is similar to a sorted_vector_set but stores
* <key,value> pairs instead of single elements. * <key,value> pairs instead of single elements.
* *
* @param class Key Key type * @tparam Key Key type
* @param class Value Value type * @tparam Value Value type
* @param class Compare Function that can compare key types and impose * @tparam Compare Function that can compare key types and impose
* a strict weak ordering over them. * a strict weak ordering over them.
* @param class Allocator allocation policy * @tparam Allocator allocation policy
* @param class GrowthPolicy policy object to control growth * @tparam GrowthPolicy policy object to control growth
* *
* @author Aditya Agarwal <aditya@fb.com> * @author Aditya Agarwal <aditya@fb.com>
* @author Akhil Wable <akhil@fb.com> * @author Akhil Wable <akhil@fb.com>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment