Commit 73d254b5 authored by Curtis Li's avatar Curtis Li Committed by Facebook GitHub Bot

Fix some -Wdocumentation errors in folly

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

fbshipit-source-id: 0bb803c6e9412e72985c17415b424be08b51a693
parent c28acad2
...@@ -126,7 +126,7 @@ class Baton { ...@@ -126,7 +126,7 @@ class Baton {
* Puts active fiber to sleep. Returns when post is called or the deadline * Puts active fiber to sleep. Returns when post is called or the deadline
* expires. * expires.
* *
* @param timeout Baton will be automatically awaken if deadline expires * @param deadline Baton will be automatically awaken if deadline expires
* *
* @return true if was posted, false if timeout expired * @return true if was posted, false if timeout expired
*/ */
...@@ -140,7 +140,7 @@ class Baton { ...@@ -140,7 +140,7 @@ class Baton {
* Puts active fiber to sleep. Returns when post is called or the deadline * Puts active fiber to sleep. Returns when post is called or the deadline
* expires. * expires.
* *
* @param timeout Baton will be automatically awaken if deadline expires * @param deadline Baton will be automatically awaken if deadline expires
* @param mainContextFunc this function is immediately executed on the main * @param mainContextFunc this function is immediately executed on the main
* context. * context.
* *
...@@ -155,7 +155,7 @@ class Baton { ...@@ -155,7 +155,7 @@ class Baton {
* Puts active fiber to sleep. Returns when post is called or the deadline * Puts active fiber to sleep. Returns when post is called or the deadline
* expires. * expires.
* *
* @param timeout Baton will be automatically awaken if deadline expires * @param deadline Baton will be automatically awaken if deadline expires
* @param mainContextFunc this function is immediately executed on the main * @param mainContextFunc this function is immediately executed on the main
* context. * context.
* *
......
...@@ -164,7 +164,7 @@ class FiberManager : public ::folly::Executor { ...@@ -164,7 +164,7 @@ class FiberManager : public ::folly::Executor {
/** /**
* Initializes, but doesn't start FiberManager loop * Initializes, but doesn't start FiberManager loop
* *
* @param loopController * @param loopController A LoopController object
* @param options FiberManager options * @param options FiberManager options
*/ */
explicit FiberManager( explicit FiberManager(
...@@ -174,7 +174,7 @@ class FiberManager : public ::folly::Executor { ...@@ -174,7 +174,7 @@ class FiberManager : public ::folly::Executor {
/** /**
* Initializes, but doesn't start FiberManager loop * Initializes, but doesn't start FiberManager loop
* *
* @param loopController * @param loopController A LoopController object
* @param options FiberManager options * @param options FiberManager options
* @tparam LocalT only local of this type may be stored on fibers. * @tparam LocalT only local of this type may be stored on fibers.
* Locals of other types will be considered thread-locals. * Locals of other types will be considered thread-locals.
...@@ -236,7 +236,7 @@ class FiberManager : public ::folly::Executor { ...@@ -236,7 +236,7 @@ class FiberManager : public ::folly::Executor {
* Sets exception callback which will be called if any of the tasks throws an * Sets exception callback which will be called if any of the tasks throws an
* exception. * exception.
* *
* @param ec * @param ec An ExceptionCallback object.
*/ */
void setExceptionCallback(ExceptionCallback ec); void setExceptionCallback(ExceptionCallback ec);
......
...@@ -51,7 +51,7 @@ class Promise { ...@@ -51,7 +51,7 @@ class Promise {
/** /**
* Fulfill the promise with a given try * Fulfill the promise with a given try
* *
* @param t * @param t A Try with either a value or an error.
*/ */
void setTry(folly::Try<T>&& t); void setTry(folly::Try<T>&& t);
......
...@@ -782,7 +782,7 @@ class EventBase : public TimeoutManager, ...@@ -782,7 +782,7 @@ class EventBase : public TimeoutManager,
* Setup execution observation/instrumentation for every EventHandler * Setup execution observation/instrumentation for every EventHandler
* executed in this EventBase. * executed in this EventBase.
* *
* @param executionObserver EventHandle's execution observer. * @param observer EventHandle's execution observer.
*/ */
void setExecutionObserver(ExecutionObserver* observer) { void setExecutionObserver(ExecutionObserver* observer) {
executionObserver_ = observer; executionObserver_ = observer;
......
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