jsdoc-inline-lex
v1.0.1
Published
lex inline tags from jsdoc text
Downloads
1,170
Readme
lex
Lex tokens out of a string input that represents some JSDoc-embedded text.
| name | description |
| ---- | ----------- |
| text
| input text. |
Examples
var result = lex('See {@link MyClass}.');
// returns
result = [
{
"type": "text",
"capture": [
" See "
]
},
{
"type": "link",
"capture": [
"{@link MyClass}",
"MyClass"
]
},
{
"type": "text",
"capture": [
".\n"
]
}
];
Returns array of lexed tokens.