documon/docs/_data/tagged_searchPrep.js

A documentation system for mortals. Use with any language.

{
	"line": 21,
	"name": "searchPrep",
	"shortText": "Clean text so it has:",
	"shortHtml": "<p>Clean text so it has:</p>",
	"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",
	"html": "<p>Clean text so it has:</p>\n<ul>\n<li>only alpha numeric characters</li>\n<li>strips newlines and tabs.</li>\n<li>single word results ignored</li>\n</ul>\n<p>Used by <a href=\"root.documon.tag\">tag.js</a> and <a href=\"root.documon.more\">more.js</a></p>",
	"entity": "class",
	"flagSearchText": " searchPrep documon text The clean text",
	"package": "documon",
	"access": "private",
	"params": [
		{
			"name": "text",
			"shortText": "text",
			"shortHtml": "<p>text</p>",
			"text": "text",
			"html": "<p>text</p>",
			"type": "string"
		}
	],
	"returns": {
		"type": "string",
		"text": "The clean text",
		"html": "<p>The clean text</p>",
		"shortText": "<p>The clean text</p>",
		"shortHtml": "<p>The clean text</p>"
	},
	"file": "documon/src/searchPrep.js",
	"filename": "searchPrep.js",
	"klass": "searchPrep",
	"docfile": "documon.searchPrep.html",
	"id": "documon.searchPrep",
	"prettyLangs": [],
	"projectName": "Documon",
	"projectVersion": "2.5.5",
	"search": {
		"documon.searchPrep": "searchPrep : Clean text only alpha numeric characters strips newlines tabs single word results ignored Used root documon more root documon moresearchPrep documon text clean text"
	}
}