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.

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

[BUG]: Function return value is formatted wrongly in the docs #622

Closed
skasgarv opened this issue Aug 20, 2018 · 4 comments
Closed

[BUG]: Function return value is formatted wrongly in the docs #622

skasgarv opened this issue Aug 20, 2018 · 4 comments

Comments

@skasgarv
Copy link

skasgarv commented Aug 20, 2018

Overview of the issue

Assume I have a Angular 5+ service and a function inside the service as follows
`
@Injectable()
export class ABC {

/**
* Gets some data
* @returns Map<string, number>
*/

get someData(): Map<string, number> {

	// do something here

}

}
`

When I run compodocs and generate the docs, Returns section is wrongly formatted to Map<stringnumber> instead of Map<string, number>
The comma in the return type is ignored.

Operating System, Node.js, npm, compodoc version(s)

Windows 10 64 bit OS
node v6.12.0
npm 3.10.10
@compodoc/compodoc": "~1.1.2"

Angular configuration, a package.json file in the root folder

Not needed. You can replicate the issue using the example provided above.

Compodoc installed globally or locally ? Locally

Any help regarding this issue is greatly appreciated. Thank you.

@skasgarv
Copy link
Author

capture

@skasgarv skasgarv changed the title Bug: Function return value is formatted wrongly in the docs [BUG]: Function return value is formatted wrongly in the docs Aug 21, 2018
@vogloblinsky vogloblinsky added this to the 1.1.4 milestone Aug 24, 2018
@vogloblinsky
Copy link
Contributor

@skasgarv could you do a test with last version, 1.1.3 ?

@skasgarv
Copy link
Author

skasgarv commented Aug 27, 2018

@vogloblinsky
I tested with version 1.1.3 and the problem still exists.
Also I can see the commit has been pushed to "develop" branch and not to version 1.1.3.

Can we reopen this Issue please until version 1.1.4 is out?
Also could you provide the ETA for version 1.1.4.
Thank you so much.

@lock
Copy link

lock bot commented Sep 30, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

@lock lock bot locked as resolved and limited conversation to collaborators Sep 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants