Skip to content

Commit cab0069

Browse files
Googlera-maurice
authored andcommitted
[c++] Add comments on EventListener
According to amaurice@, the lack of comments on this template is causing the doc generator to error out PiperOrigin-RevId: 293023679
1 parent 175b9a9 commit cab0069

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

firestore/src/include/firebase/firestore/event_listener.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,17 @@ class EventListener {
4040
virtual void OnEvent(const T& value, Error error) = 0;
4141
};
4242

43+
/** Interface used for void EventListeners that don't produce a value. */
4344
template <>
4445
class EventListener<void> {
4546
public:
4647
virtual ~EventListener() = default;
48+
49+
/**
50+
* @brief OnEvent will be called with the error if an error occurred.
51+
*
52+
* @param error The error if there was error. Error::Ok otherwise.
53+
*/
4754
virtual void OnEvent(Error error) = 0;
4855
};
4956

0 commit comments

Comments
 (0)