Skip to content

Commit b282498

Browse files
authored
Fix docs for setting and getting the dispatch queue in Firestore's settings
1 parent c21ea9d commit b282498

File tree

1 file changed

+30
-4
lines changed
  • firestore/src/include/firebase/firestore

1 file changed

+30
-4
lines changed

firestore/src/include/firebase/firestore/settings.h

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,15 +155,41 @@ class Settings final {
155155
*/
156156
void set_cache_size_bytes(int64_t value);
157157

158-
#if defined(__OBJC__)
158+
#if defined(__OBJC__) || defined(DOXYGEN)
159159
/**
160-
* A dispatch queue to be used to execute all completion handlers and event
161-
* handlers. By default, the main queue is used.
160+
* Returns a dispatch queue that Firestore will use to execute callbacks.
161+
*
162+
* The returned dispatch queue is used for all completion handlers and event
163+
* handlers.
164+
*
165+
* If no dispatch queue is explictly set by calling `set_dispatch_queue()`
166+
* then a dedicated "callback queue" will be used; namely, the main thread
167+
* will not be used for callbacks unless expliclty set to do so by a call to
168+
* `set_dispatch_queue()`.
169+
*
170+
* @note This method is only available when `__OBJC__` is defined, such as
171+
* when compiling for iOS.
172+
*
173+
* @see `set_dispatch_queue(dispatch_queue_t)` for information on how to
174+
* explicitly set the dispatch queue to use.
162175
*/
163176
dispatch_queue_t dispatch_queue() const;
164177

178+
/**
179+
* Sets the dispatch queue that Firestore will use to execute callbacks.
180+
*
181+
* The specified dispatch queue will be used for all completion handlers and
182+
* event handlers.
183+
*
184+
* @param queue The dispatch queue to use.
185+
*
186+
* @note This method is only available when `__OBJC__` is defined, such as
187+
* when compiling for iOS.
188+
*
189+
* @see `dispatch_queue()` for the "get" counterpart to this method.
190+
*/
165191
void set_dispatch_queue(dispatch_queue_t queue);
166-
#endif
192+
#endif // defined(__OBJC__) || defined(DOXYGEN)
167193

168194
/**
169195
* Returns a string representation of these `Settings` for

0 commit comments

Comments
 (0)