API Extractor Doc fixes #4105
API Extractor Doc fixes #4105
Conversation
- Use instead of - Add - for - HTML escape special charaters - Fix @link tags
|
Size Analysis ReportAffected ProductsNo changes between base commit (3a19f9e) and head commit (31ea4ae). Test Logs
|
| @@ -22,7 +22,7 @@ import { PersistencePromise } from './persistence_promise'; | |||
| /** | |||
| * Represents a set of indexes that are used to execute queries efficiently. | |||
| * | |||
| * Currently the only index is a [collection id] => [parent path] index, used | |||
| * Currently the only index is a [collection id] => [parent path] index, used | |||
There was a problem hiding this comment.
Why do we need to escape it? Does it not work in markdown?
There was a problem hiding this comment.
API Extractor complains about all these HTML-like characters (at least with default settings).
|
|
||
| /** | ||
| * Called by the Firestore SDK to convert a custom model object of type `T` | ||
| * into a plain Javascript object (suitable for writing directly to the |
There was a problem hiding this comment.
ultranit: "Javascript" -> "JavaScript"
API Extractor will be used to generate the reference documentation for firestore-exp. It currently throws some validation errors, and this fixes them by doing the following:
@returnsinstead of@return@param@linktags@hideconstructorfor non-public (internal) constructorsI don't think this needs a thorough review, but a spot check would be nice.