-
Notifications
You must be signed in to change notification settings - Fork 719
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Functions do no output unsupported tags #1220
Comments
Update: Looks like there is a discrepancy in the JSON as well, I just didn't notice it before. It looks like when you generate the JSON in the 1st case, where it's a regular method declaration, the 1st way (outputs the tags correctly in the HTML): {
"id": 5,
"name": "testMethod",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPublic": true,
"isExported": true
},
"comment": {
"shortText": "This will do some test things",
"tags": [
{
"tag": "deprecated",
"text": ""
}
]
},
"signatures": [
{
"id": 6,
"name": "testMethod",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "This will do some test things"
},
... 2nd way (does not output the tags in the HTML: {
"id": 5,
"name": "testMethod",
"kind": 2048,
"kindString": "Method",
"flags": {
"isPublic": true,
"isExported": true
},
"signatures": [
{
"id": 6,
"name": "testMethod",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "This will do some test things",
"tags": [
{
"tag": "deprecated",
"text": ""
}
]
},
... |
Expected Behavior
According to the docs:
TypeDoc renders any unsupported tags in a list in the documentation, so they are not lost
.Actual Behavior
This seems to work fine with class methods defined like this:
... but when I try to add an unsupported tag to a regular function, arrow function, or even to a class method that's defined with arrow-function syntax:
The tag doesn't show up in the generated documentation for any of those. When I output the JSON, I see that the comment has that tag, but it isn't being rendered in the output. This may very well be that I'm just doing something wrong! But I'd love to know what that is. 😄
Steps to reproduce the bug
@deprecated
tag to the comment for that methodconst
declarations with arrow-function syntax)@deprecated
tag shows up in the documentation for the first one, but not the second.Environment
The text was updated successfully, but these errors were encountered: