Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Comment are not rendered when brackets are around an optional parameter #567

Closed
krenor opened this issue Jul 26, 2017 · 3 comments
Closed

Comment are not rendered when brackets are around an optional parameter #567

krenor opened this issue Jul 26, 2017 · 3 comments
Labels
enhancement Improved functionality
Projects
TSDoc - v0.23
Milestone
v0.23

Comments

@krenor
Copy link

krenor commented Jul 26, 2017 •
edited

Using JSDoc Syntax

@param {string} [key] An optional but fancy key

With brackets

@param {string} key An optional but fancy key

Without brackets
@aciccarello
Copy link
Collaborator

Hi @krenor, TypeDoc does not completely follow the JSDoc syntax but I think this is something that should be supported. PRs are welcome.

@aciccarello aciccarello added the enhancement Improved functionality label Jul 26, 2017
@microshine
Copy link

I've got the same problem.
I use Document This plugin for VisualStudio Code which uses correct JSDOC annotations (JSDOC Optional parameters and default values).

jeremymeng added a commit to jeremymeng/azure-sdk-for-js that referenced this issue Apr 23, 2019
@jeremymeng
Work around typedoc issue
d2e29d8 
where comments are not rendered when there are brackets around optional
parameter name (TypeStrong/typedoc#567).
jeremymeng added a commit to Azure/azure-sdk-for-js that referenced this issue Apr 23, 2019
@jeremymeng
Highlevel functions (#2376)
af11361 
* Add high level functions that takes string url parameters

* Use intersection types for options parameter

* Add documentation

* Add type alias for the intersection types

* Add docs for alias types

* Work around typedoc issue

where comments are not rendered when there are brackets around optional
parameter name (TypeStrong/typedoc#567).
jeremymeng added a commit to jeremymeng/azure-sdk-for-js that referenced this issue May 10, 2019
@jeremymeng
Highlevel functions (Azure#2376)
d7a24f0 
* Add high level functions that takes string url parameters

* Use intersection types for options parameter

* Add documentation

* Add type alias for the intersection types

* Add docs for alias types

* Work around typedoc issue

where comments are not rendered when there are brackets around optional
parameter name (TypeStrong/typedoc#567).
Closed
@Gerrit0 Gerrit0 added this to To do in TSDoc - v0.23 via automation Sep 12, 2021
@3bl3gamer 3bl3gamer mentioned this issue Nov 27, 2021
Closed
@pkuczynski pkuczynski mentioned this issue Jan 29, 2022
Merged
@ST-DDT
Copy link

ST-DDT commented Jan 29, 2022

Linking to the PR with a proposed fix for better visibility:
#1810

@Gerrit0 Gerrit0 moved this from To do to Done in TSDoc - v0.23 Feb 18, 2022
@Gerrit0 Gerrit0 added this to the v0.23 milestone Apr 17, 2022
@Gerrit0 Gerrit0 closed this as completed Jun 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improved functionality
Projects
No open projects
TSDoc - v0.23
Done
Milestone
v0.23
Development

No branches or pull requests
5 participants
@ST-DDT @microshine @aciccarello @krenor @Gerrit0