Fix undocumented docs

Author: schmidt-sebastian

common/api-review/database-exp.api.md

@@ -16,7 +16,6 @@ export class DataSnapshot {
     hasChildren(): boolean;
     get key(): string | null;
     get priority(): string | number | null;
-    // (undocumented)
     readonly ref: Reference;
     get size(): number;
     toJSON(): object | null;
@@ -43,9 +42,7 @@ export type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved
 
 // @public
 export class FirebaseDatabase {
-    // (undocumented)
     readonly app: FirebaseApp;
-    // (undocumented)
     readonly 'type' = "database";
 }
 
@@ -215,14 +212,10 @@ export interface TransactionOptions {
     readonly applyLocally?: boolean;
 }
 
-// @public (undocumented)
+// @public
 export class TransactionResult {
-    constructor(committed: boolean, snapshot: DataSnapshot);
-    // (undocumented)
     readonly committed: boolean;
-    // (undocumented)
     readonly snapshot: DataSnapshot;
-    // (undocumented)
     toJSON(): object;
 }
 

packages/database/src/api/Reference.ts

@@ -72,6 +72,7 @@ import { runTransaction } from '../exp/Transaction';
 import { Database } from './Database';
 import { OnDisconnect } from './onDisconnect';
 import { TransactionResult } from './TransactionResult';
+
 /**
  * Class representing a firebase data snapshot.  It wraps a SnapshotNode and
  * surfaces the public methods (val, forEach, etc.) we want to expose.

packages/database/src/exp/Database.ts

@@ -200,6 +200,7 @@ export function repoManagerForceRestClient(forceRestClient: boolean): void {
  * Class representing a Firebase Realtime Database.
  */
 export class FirebaseDatabase implements _FirebaseService {
+  /** Represents a database instance. */
   readonly 'type' = 'database';
 
   /** Track if the instance has been used (root or repo accessed) */
@@ -209,7 +210,11 @@ export class FirebaseDatabase implements _FirebaseService {
   private _rootInternal?: ReferenceImpl;
 
   /** @hideconstructor */
-  constructor(private _repoInternal: Repo, readonly app: FirebaseApp) {}
+  constructor(
+    private _repoInternal: Repo,
+    /** The FirebaseApp associated with this Realtime Database instance. */
+    readonly app: FirebaseApp
+  ) {}
 
   get _repo(): Repo {
     if (!this._instanceStarted) {

packages/database/src/exp/Reference_impl.ts

@@ -289,6 +289,7 @@ export class DataSnapshot {
    */
   constructor(
     readonly _node: Node,
+    /** The location of this DataSnapshot. */
     readonly ref: ReferenceImpl,
     readonly _index: Index
   ) {}

packages/database/src/exp/Transaction.ts

@@ -36,12 +36,19 @@ export interface TransactionOptions {
   readonly applyLocally?: boolean;
 }
 
+/**
+ * A type for the resolve value of Firebase.transaction.
+ */
 export class TransactionResult {
-  /**
-   * A type for the resolve value of Firebase.transaction.
-   */
-  constructor(readonly committed: boolean, readonly snapshot: DataSnapshot) {}
+  /** @hideconstructor */
+  constructor(
+    /** Whether the transaction was successfully committed. */
+    readonly committed: boolean,
+    /** The resulting data snapshot. */
+    readonly snapshot: DataSnapshot
+  ) {}
 
+  /** Returns a JSON-serializable representation of this object. */
   toJSON(): object {
     return { committed: this.committed, snapshot: this.snapshot.toJSON() };
   }