documon
Version:
A documentation system for mortals. Use with any language.
53 lines • 1.57 kB
JavaScript
[
{
"text": "Clean text so it has:\n- only alpha numeric characters\n- strips newlines and tabs.\n- single word results ignored\n\nUsed by [tag.js](root.documon.tag) and [more.js](root.documon.more)\n\n\n",
"start": 6,
"end": 20,
"file": "/Volumes/Drives/projects/documon/documon/src/searchPrep.js",
"flags": [
{
"source": "@class searchPrepsearchPrep",
"flag": "class",
"after": "searchPrep",
"afterType": "searchPrep",
"name": "searchPrep",
"single": true,
"text": "searchPrep"
},
{
"source": "@package documondocumon",
"flag": "package",
"after": "documon",
"afterType": "documon",
"name": "documon",
"single": true,
"text": "documon"
},
{
"source": "@private",
"flag": "private",
"after": ""
},
{
"source": "@param {string} texttext",
"flag": "param",
"after": "{string} text",
"type": "string",
"afterType": "text",
"name": "text",
"single": true,
"text": "text"
},
{
"source": "@returns {string} - The clean text",
"flag": "returns",
"after": "{string} - The clean text",
"type": "string",
"afterType": "The clean text",
"text": "The clean text"
}
],
"source": "Clean text so it has:\n- only alpha numeric characters\n- strips newlines and tabs.\n- single word results ignored\n\nUsed by [tag.js](root.documon.tag) and [more.js](root.documon.more)\n\n\n@class searchPrep\n@package documon\n@private\n@param {string} text\n@returns {string} - The clean text",
"id": "documon.searchPrep"
}
]