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

fix: prevent jsdoc see tag from causing crashes #173

Merged
merged 1 commit into from
Apr 10, 2022

Conversation

yradchen
Copy link

@yradchen yradchen commented Jan 26, 2022

Previously the @see jsdoc tag would break flowgen compilation - check References issue

This adds some support for the @see tag, though there are still some issues (see https example in test). Overall, though I think it's an improvement since it prevents crashing and there are still a lot of other jsdoc issues as other complimentary tags like @link do not work.

Example of LINK tag not working (NOT AFFECTED BY THIS CHANGE)

/**
 * See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}.
 * Also, check out {@link http://www.google.com|Google} and
 * {@link https://github.com GitHub}.
 */
export declare function myFunction(): void;

Output by flowgen

/**
 * [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
 */
declare export function myFunction(): void;

@orta
Copy link
Collaborator

orta commented Apr 10, 2022

Great, thanks

@orta orta merged commit 6714764 into joarwilk:master Apr 10, 2022
@orta
Copy link
Collaborator

orta commented Apr 10, 2022

Shipped in 1.18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants