Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
fc17f18
add typedoc generation, somewhat working
thechenky Jun 27, 2019
7629048
fix from admin => functions in a comment
thechenky Jun 27, 2019
dd06123
add npm run apidocs command to generate apidocs
thechenky Jun 27, 2019
e4cb222
modify to use modules instead of file mode
thechenky Jul 9, 2019
0248c8d
change toc to match modules mode of typedoc
thechenky Jul 9, 2019
ed0f30a
add UserInfo to be generated, modify toc.yaml to correct links
thechenky Jul 9, 2019
8547a7e
add missing sections to toc.yaml
thechenky Jul 9, 2019
541b129
Merge branch 'master' into dt-docgen
thechenky Jul 9, 2019
faf5c67
fix merge conflict
thechenky Jul 9, 2019
9765849
fix erroneous warnings about missing and unlisted files
thechenky Jul 9, 2019
007080f
Merge branch 'master' into dt-docgen
thechenky Jul 10, 2019
e61e4ab
remove underscores
thechenky Jul 10, 2019
0b4dd34
edit toc.yaml to fix the links
thechenky Jul 10, 2019
311f0ec
remove underscores in links inside the html files
thechenky Jul 10, 2019
eec23dd
unhide Event
thechenky Jul 10, 2019
2987a80
Merge branch 'master' into dt-docgen
thechenky Jul 11, 2019
b62db9e
hide Event
thechenky Jul 11, 2019
d34b799
add docgen/html to gitignore
thechenky Jul 11, 2019
729d469
formatting
thechenky Jul 11, 2019
4f9b61d
remove Event from toc, add proper toc file checking
thechenky Jul 11, 2019
81464ee
clean up docgen script
thechenky Jul 11, 2019
b8ff3de
Merge branch 'master' into dt-docgen
thechenky Jul 11, 2019
8acf836
Merge branch 'master' into dt-docgen
thechenky Jul 11, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
.tmp
.vscode/
coverage
docgen/html
firebase-functions-*.tgz
integration_test/.firebaserc
integration_test/*.log
Expand Down
3 changes: 3 additions & 0 deletions docgen/content-sources/HOME.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Firebase Functions SDK Reference

Functions SDK!!!
114 changes: 114 additions & 0 deletions docgen/content-sources/toc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
toc:
- title: 'functions'
path: /docs/reference/functions/cloud_functions_.html
section:
- title: 'CloudFunction'
path: /docs/reference/functions/cloud_functions_.html#cloudfunction
- title: 'HttpsFunction'
path: /docs/reference/functions/cloud_functions_.html#httpsfunction
- title: 'EventContext'
path: /docs/reference/functions/cloud_functions_.eventcontext.html
- title: 'FunctionBuilder'
path: /docs/reference/functions/function_builder_.functionbuilder.html
- title: 'Change'
path: /docs/reference/functions/cloud_functions_.change.html

- title: 'functions.config'
path: /docs/reference/functions/config_.html
section:
- title: 'Config'
path: /docs/reference/functions/config_.config.html

- title: 'functions.analytics'
path: /docs/reference/functions/providers_analytics_.html
section:
- title: 'AnalyticsEvent'
path: /docs/reference/functions/providers_analytics_.analyticsevent.html
- title: 'AnalyticsEventBuilder'
path: /docs/reference/functions/providers_analytics_.analyticseventbuilder.html
- title: 'AppInfo'
path: /docs/reference/functions/providers_analytics_.appinfo.html
- title: 'DeviceInfo'
path: /docs/reference/functions/providers_analytics_.deviceinfo.html
- title: 'ExportBundleInfo'
path: /docs/reference/functions/providers_analytics_.exportbundleinfo.html
- title: 'GeoInfo'
path: /docs/reference/functions/providers_analytics_.geoinfo.html
- title: 'UserDimensions'
path: /docs/reference/functions/providers_analytics_.userdimensions.html
- title: 'UserPropertyValue'
path: /docs/reference/functions/providers_analytics_.userpropertyvalue.html

- title: 'functions.auth'
path: /docs/reference/functions/providers_auth_.html
section:
- title: 'UserBuilder'
path: /docs/reference/functions/providers_auth_.userbuilder.html
- title: 'UserInfo'
path: /docs/reference/functions/providers_auth_.html#userinfo
- title: 'UserRecordMetadata'
path: /docs/reference/functions/providers_auth_.userrecordmetadata.html
- title: 'UserRecord'
path: /docs/reference/functions/providers_auth_.html#userrecord

- title: 'functions.crashlytics'
path: /docs/reference/functions/providers_crashlytics_.html
section:
- title: 'Issue'
path: /docs/reference/functions/providers_crashlytics_.issue.html
- title: 'IssueBuilder'
path: /docs/reference/functions/providers_crashlytics_.issuebuilder.html
- title: 'AppInfo'
path: /docs/reference/functions/providers_crashlytics_.appinfo.html
- title: 'VelocityAlert'
path: /docs/reference/functions/providers_crashlytics_.velocityalert.html

- title: 'functions.firestore'
path: /docs/reference/functions/providers_firestore_.html
section:
- title: 'DocumentBuilder'
path: /docs/reference/functions/providers_firestore_.documentbuilder.html
- title: 'DocumentSnapshot'
path: /docs/reference/functions/providers_firestore_.html#documentsnapshot

- title: 'functions.database'
path: /docs/reference/functions/providers_database_.html
section:
- title: 'DataSnapshot'
path: /docs/reference/functions/providers_database_.datasnapshot.html
- title: 'RefBuilder'
path: /docs/reference/functions/providers_database_.refbuilder.html
- title: 'InstanceBuilder'
path: /docs/reference/functions/providers_database_.instancebuilder.html

- title: 'functions.https'
path: /docs/reference/functions/providers_https_.html
section:
- title: 'HttpsError'
path: /docs/reference/functions/providers_https_.httpserror.html

- title: 'functions.pubsub'
path: /docs/reference/functions/providers_pubsub_.html
section:
- title: 'Message'
path: /docs/reference/functions/providers_pubsub_.message.html
- title: 'TopicBuilder'
path: /docs/reference/functions/providers_pubsub_.topicbuilder.html

- title: 'functions.remoteconfig'
path: /docs/reference/functions/providers_remoteconfig_.html
section:
- title: 'RemoteConfigUser'
path: /docs/reference/functions/providers_remoteconfig_.remoteconfiguser.html
- title: 'TemplateVersion'
path: /docs/reference/functions/providers_remoteconfig_.templateversion.html

- title: 'functions.storage'
path: /docs/reference/functions/providers_storage_.html
section:
- title: 'BucketBuilder'
path: /docs/reference/functions/providers_storage_.bucketbuilder.html
- title: 'ObjectBuilder'
path: /docs/reference/functions/providers_storage_.objectbuilder.html
- title: 'ObjectMetadata'
path: /docs/reference/functions/providers_storage_.objectmetadata.html
Loading