Small fixes to Firestore doc comments.

PiperOrigin-RevId: 297232608

Author: var-const

firestore/src/include/firebase/firestore.h

@@ -51,6 +51,12 @@
 #include "firebase/firestore/timestamp.h"
 
 namespace firebase {
+/**
+ * @brief Cloud Firestore API.
+ *
+ * Cloud Firestore is a flexible, scalable database for mobile, web, and server
+ * development from Firebase and Google Cloud Platform.
+ */
 namespace firestore {
 
 class FirestoreInternal;

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

@@ -22,7 +22,12 @@
 namespace firebase {
 namespace firestore {
 
-/** An interface for event listeners. */
+/**
+ * An interface for event listeners.
+ *
+ * @note This class should only be used when using the STLPort C++ runtime
+ * library.
+ */
 template <typename T>
 class EventListener {
  public:
@@ -40,13 +45,18 @@ class EventListener {
   virtual void OnEvent(const T& value, Error error) = 0;
 };
 
-/** Interface used for void EventListeners that don't produce a value. */
+/**
+ * Interface used for void EventListeners that don't produce a value.
+ *
+ * @note This class should only be used when using the STLPort C++ runtime
+ * library.
+ */
 template <>
 class EventListener<void> {
  public:
   virtual ~EventListener() = default;
 
-   /**
+  /**
    * @brief OnEvent will be called with the error if an error occurred.
    *
    * @param error The error if there was error. Error::Ok otherwise.

firestore/src/include/firebase/firestore/map_field_value.h

@@ -27,10 +27,14 @@ class FieldPath;
 class FieldValue;
 
 #ifdef STLPORT
+/** @brief A map of `FieldValue`s indexed by stringified field paths. */
 using MapFieldValue = std::tr1::unordered_map<std::string, FieldValue>;
+/** @brief A map of `FieldValue`s indexed by field paths. */
 using MapFieldPathValue = std::tr1::unordered_map<FieldPath, FieldValue>;
 #else
+/** @brief A map of `FieldValue`s indexed by stringified field paths. */
 using MapFieldValue = std::unordered_map<std::string, FieldValue>;
+/** @brief A map of `FieldValue`s indexed by field paths. */
 using MapFieldPathValue = std::unordered_map<FieldPath, FieldValue>;
 #endif
 

firestore/src/include/firebase/firestore/metadata_changes.h

@@ -26,7 +26,13 @@ namespace firestore {
  * trigger snapshot events.
  */
 enum class MetadataChanges {
+  /** Snapshot events will not be triggered by metadata-only changes. */
   kExclude,
+
+  /**
+   * Snapshot events will be triggered by any changes, including metadata-only
+   * changes.
+   */
   kInclude,
 };