docs: add script to build and deploy API docs to firebase hosting

Author: jeffbcross

.gitignore

@@ -1,5 +1,6 @@
 node_modules/
 dist/
+docs/api/
 typings/
 npm-debug.log
 .idea/

docs/firebase.json

@@ -0,0 +1,16 @@
+{
+  "firebase": "angular-fire-2",
+  "public": ".",
+  "redirects": [
+    {
+      "source": "/",
+      "destination": "/api",
+      "type": 302
+    }
+  ],
+  "ignore": [
+    "firebase.json",
+    "**/.*",
+    "**/node_modules/**"
+  ]
+}

package.json

@@ -5,6 +5,7 @@
   "main": "./dist/angularfire2.js",
   "scripts": {
     "test": "npm run build; karma start",
+    "docs": "typedoc --out docs/api/ --module commonjs --mode modules --name AngularFire2 src",
     "build": "rm -rf dist; tsc && cp package.json README.md LICENSE .npmignore dist/",
     "postbuild": "node tools/rewrite-published-package.js",
     "postinstall": "typings install; webdriver-manager update",
@@ -54,6 +55,7 @@
     "systemjs-builder": "^0.15.7",
     "traceur": "0.0.96",
     "tsd": "^0.6.5",
+    "typedoc": "github:jeffbcross/typedoc",
     "typescript": "1.7.5",
     "typings": "^0.6.2",
     "zone.js": "0.5.15"

src/angularfire2.ts

@@ -63,7 +63,10 @@ export const WORKER_RENDER_FIREBASE_PROVIDERS: any[] = [
   }),
   MessageBasedFirebaseAuth
 ];
-
+/**
+ * Used to define the default Firebase root location to be
+ * used throughout an application.
+ */
 export const defaultFirebase = (url: string): Provider => {
   return provide(FirebaseUrl, {
     useValue: url