docs: MatMenu api docs are not generated #16219
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
Currently the `MatMenu` API docs are not generated because the `MatMenu` class is no longer treated as directive/component because there is no decorator w/ directive metadata. In order to fix this in a flexible way, a new JSdoc tag has been introduced that allows enforcing the public state of a symbol (with the possibility of having a public symbol name). This allows us to actually expose the real `_MatMenu` class w/ directive metadata in the API docs under the `MatMenu` symbol name. Fixes angular#16198
devversion
added
pr: merge safe
target: patch
googlebot
added
the
cla: yes
|
@jelbourn I wasn't too sure what we should do with the |
josephperrott
pushed a commit
that referenced
this pull request
Jun 10, 2019
Currently the `MatMenu` API docs are not generated because the `MatMenu` class is no longer treated as directive/component because there is no decorator w/ directive metadata. In order to fix this in a flexible way, a new JSdoc tag has been introduced that allows enforcing the public state of a symbol (with the possibility of having a public symbol name). This allows us to actually expose the real `_MatMenu` class w/ directive metadata in the API docs under the `MatMenu` symbol name. Fixes #16198
RudolfFrederiksen
pushed a commit
to RudolfFrederiksen/material2
that referenced
this pull request
Jun 21, 2019
Currently the `MatMenu` API docs are not generated because the `MatMenu` class is no longer treated as directive/component because there is no decorator w/ directive metadata. In order to fix this in a flexible way, a new JSdoc tag has been introduced that allows enforcing the public state of a symbol (with the possibility of having a public symbol name). This allows us to actually expose the real `_MatMenu` class w/ directive metadata in the API docs under the `MatMenu` symbol name. Fixes angular#16198
|
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.
Currently the
MatMenuAPI docs are not generated because theMatMenuclass is no longer treated as directive/component because there is no
decorator w/ directive metadata.
In order to fix this in a flexible way, a new JSdoc tag has been introduced
that allows enforcing the public state of a symbol (with the possibility of
having a public symbol name). This allows us to actually expose the
real
_MatMenuclass w/ directive metadata in the API docs under theMatMenusymbol name.Fixes #16198