Skip to content

Commit 54eb813

Browse files
Googlera-maurice
authored andcommitted
Improvements to Doxygen markup:
- Add explicit namespace qualifier for references to a namespace-qualified enum constant from the doc string for a class member; this is needed to get DOxygen to create a link. - Add backticks around code segment ("std::function") that should be in code font. PiperOrigin-RevId: 266397807
1 parent b173d84 commit 54eb813

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

app/src/include/firebase/future.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,13 @@ class FutureBase {
123123
/// Completion status of the asynchronous call.
124124
FutureStatus status() const;
125125

126-
/// When status() is kFutureStatusComplete, returns the API-defined
126+
/// When status() is firebase::kFutureStatusComplete, returns the API-defined
127127
/// error code. Otherwise, return value is undefined.
128128
int error() const;
129129

130-
/// When status() is kFutureStatusComplete, returns the API-defined error
131-
/// message, as human-readable text, or an empty string if the API does not
132-
/// provide a human readable description of the error.
130+
/// When status() is firebase::kFutureStatusComplete, returns the API-defined
131+
/// error message, as human-readable text, or an empty string if the API does
132+
/// not provide a human readable description of the error.
133133
///
134134
/// @note The returned pointer is only valid for the lifetime of the Future
135135
/// or its copies.
@@ -163,7 +163,7 @@ class FutureBase {
163163
/// @param[in] callback Function or lambda to call.
164164
///
165165
/// @note This method is not available when using STLPort on Android, as
166-
/// std::function is not supported on STLPort.
166+
/// `std::function` is not supported on STLPort.
167167
void OnCompletion(std::function<void(const FutureBase&)> callback) const;
168168
#endif // defined(FIREBASE_USE_STD_FUNCTION) || defined(DOXYGEN)
169169

@@ -313,7 +313,7 @@ class Future : public FutureBase {
313313
/// @param[in] callback Function or lambda to call.
314314
///
315315
/// @note This method is not available when using STLPort on Android, as
316-
/// std::function is not supported on STLPort.
316+
/// `std::function` is not supported on STLPort.
317317
///
318318
/// @note This is the same callback as FutureBase::OnCompletion(), so you
319319
/// can't expect to set both and have both run; again, only the most recently

0 commit comments

Comments
 (0)