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

Invalid JSDoc (quick fix). #56

Open
ast-s-karakhanian opened this issue May 3, 2023 · 1 comment
Open

Invalid JSDoc (quick fix). #56

ast-s-karakhanian opened this issue May 3, 2023 · 1 comment

Comments

@ast-s-karakhanian
Copy link

ast-s-karakhanian commented May 3, 2023

Is it possible to adjust JSDoc through the code?
In case if project contains JSDoc validation there are such errors (e.g. when using masonry-layout which uses outlayer):

ERROR: Unable to parse a tag's type expression for source file some.js in line XXX with tag title "param" and text "{Array of Outlayer.Items} items": Invalid type expression "Array of Outlayer.Items": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ...with tag title "param" and text "{Array of Outlayer.Items} items": Invalid type expression "Array of Outlayer.Items": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array of Outlayer.Items} items": Invalid type expression "Array of Outlayer.Items": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array of Outlayer.Items} items": Invalid type expression "Array of Outlayer.Items": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or Element} elems": Invalid type expression "Array or NodeList or Element": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or Element} elems": Invalid type expression "Array or NodeList or Element": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Element, String} element": Invalid type expression "Element, String": Expected "!", "#", "$", "(", "-", ".", "/", "0", ":", "<", "=", "?", "@", "[]", "\\", "_", "|", "~", "‌", "‍", Unicode combining mark, Unicode decimal number, Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode punctuation connector, Unicode titlecase letter, Unicode uppercase letter, [1-9], or end of input but "," found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Element, String} element": Invalid type expression "Element, String": Expected "!", "#", "$", "(", "-", ".", "/", "0", ":", "<", "=", "?", "@", "[]", "\\", "_", "|", "~", "‌", "‍", Unicode combining mark, Unicode decimal number, Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode punctuation connector, Unicode titlecase letter, Unicode uppercase letter, [1-9], or end of input but "," found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or HTMLElement} elems": Invalid type expression "Array or NodeList or HTMLElement": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or HTMLElement} elems": Invalid type expression "Array or NodeList or HTMLElement": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or HTMLElement} elems": Invalid type expression "Array or NodeList or HTMLElement": Expected "|" but "o" found.

May be better to use:

  • @param {Element|string}
  • @param {Array|NodeList|HTMLElement}
  • @param {Array|NodeList|Element}
  • @param {Array} (instead of "Array of Outlayer.Items").
@ast-s-karakhanian
Copy link
Author

@desandro , @fedot , @tramck , @TeaSeaLancs , @toksea , @mpickell , @sculove , hi. I see last activities were 6-8 years ago. :D )))
I can adjust this (create PR) by myself if someone give me access for 1 day. )))

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

No branches or pull requests

1 participant