metafizzy / outlayer

:construction_worker: the brains & guts of a layout library
163 stars 63 forks source link

Invalid JSDoc (quick fix). #56

Open ast-s-karakhanian opened 1 year ago

ast-s-karakhanian commented 1 year ago

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:

ast-s-karakhanian commented 1 year ago

@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. )))