mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-02-01 11:49:10 +00:00
Code Issues Releases Wiki Activity

docs: shorten JSDoc comment as requsted

Browse Source
This commit is contained in:
linonetwo 2024-09-12 11:47:02 +08:00
parent 43eff4eb3a
commit cdceeddddb
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
core/modules/parsers/wikiparser/wikiparser.js
View File

@ -30,13 +30,13 @@ Attributes are stored as hashmaps of the following objects:
* *
* @class * @class
* @constructor * @constructor
* @param {string} type - The content type of the text to be parsed. * @param {string} type - Content type of the text to be parsed
* @param {string} text - The text to be parsed. * @param {string} text - Text to be parsed
* @param {Object} options - Options for parsing. * @param {Object} options - Parser options
* @param {boolean} [options.parseAsInline=false] - If true, the text will be parsed as an inline run. * @param {boolean} [options.parseAsInline=false] - If true, the text will be parsed as an inline run
* @param {Object} options.wiki - Reference to the wiki to use. * @param {Object} options.wiki - Reference to the wiki store in use
* @param {string} [options._canonical_uri] - Optional URI of the content if the text is missing or empty. * @param {string} [options._canonical_uri] - Optional URI of the content if text is missing or empty
* @param {boolean} [options.configTrimWhiteSpace=false] - If true, trims white space according to configuration. * @param {boolean} [options.configTrimWhiteSpace=false] - If true, the parser trims white space
*/ */
function WikiParser(type,text,options) { function WikiParser(type,text,options) {
this.wiki = options.wiki; this.wiki = options.wiki;

18
core/modules/wiki.js
View File

@ -1041,17 +1041,17 @@ exports.initParsers = function(moduleType) {
*/ */
/** /**
* Parse a block of text of a specified MIME type. * Parse a block of text of a specified MIME type
* *
* @param {string} type - The content type of the text to be parsed. * @param {string} type - Content type of text to be parsed
* @param {string} text - The text to be parsed. * @param {string} text - Text to be parsed
* @param {Object} [options] - Options for parsing. * @param {Object} [options] - Options for parsing
* @param {boolean} [options.parseAsInline=false] - If true, the text will be parsed as an inline run. * @param {boolean} [options.parseAsInline=false] - If true, text will be parsed as an inline run
* @param {string} [options._canonical_uri] - Optional string of the canonical URI of this content. * @param {string} [options._canonical_uri] - Optional string of canonical URI of this content
* @param {string} [options.defaultType="text/vnd.tiddlywiki"] - The default type to use if no parser is found for the specified type. * @param {string} [options.defaultType="text/vnd.tiddlywiki"] - Default type to use if no parser is found for specified type
* @param {boolean} [options.configTrimWhiteSpace=false] - If true, trims white space according to configuration. * @param {boolean} [options.configTrimWhiteSpace=false] - If true, trims white space according to configuration
* *
* @returns {WikiParser|null} The parser instance or null if no parser is found. * @returns {WikiParser|null} Parser instance or null if no parser is found
*/ */
exports.parseText = function(type,text,options) { exports.parseText = function(type,text,options) {
text = text || ""; text = text || "";