docs: fix inherited docs-private members showing up #22890
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We recently landed a couple of improvements in the Dgeni pipeline, so that descriptions of inherited members show up. To achieve this, we applied a workaround that basically meant we are parsing the API doc's` string cotntent manually to a JSDoc description (this also involved manually stripping any JSDoc annotations). This commit replaces the workaround with a solution that allows us to still run necessary default Dgeni processors on the inherited API docs, such as the offical `jsdoc` processors. These solve the problem of manually extracting the JSDOc description, and also fix more down-the-line problems where e.g. `@docs-private` is not respected for inherited members. It also fixes cases where the JSDOc annotations are still showing up in the docs.
google-cla
bot
added
the
cla: yes
devversion
added
merge safe
target: patch
crisbeto
approved these changes
Jun 5, 2021
andrewseguin
pushed a commit
that referenced
this pull request
Jun 7, 2021
We recently landed a couple of improvements in the Dgeni pipeline, so that descriptions of inherited members show up. To achieve this, we applied a workaround that basically meant we are parsing the API doc's` string cotntent manually to a JSDoc description (this also involved manually stripping any JSDoc annotations). This commit replaces the workaround with a solution that allows us to still run necessary default Dgeni processors on the inherited API docs, such as the offical `jsdoc` processors. These solve the problem of manually extracting the JSDOc description, and also fix more down-the-line problems where e.g. `@docs-private` is not respected for inherited members. It also fixes cases where the JSDOc annotations are still showing up in the docs. (cherry picked from commit 68e5566)
|
For reference: Here is the docs content diff |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We recently landed a couple of improvements in the Dgeni pipeline, so
that descriptions of inherited members show up. To achieve this, we
applied a workaround that basically meant we are parsing the API docs'
string content manually to a JSDoc description (this also involved
manually stripping any JSDoc annotations).
This commit replaces the workaround with a solution that allows us
to still run necessary default Dgeni processors on the inherited API
docs, such as the offical
jsdocprocessors. These solve the problemof manually extracting the JSDoc description, and also fix more
down-the-line problems where e.g.
@docs-privateis not respectedfor inherited members. It also fixes cases where the JSDoc annotations
are still showing up in the docs.