Skip to content

Commit

Permalink
Removed superfluous @param comments
Browse files Browse the repository at this point in the history
  • Loading branch information
DreierF committed May 29, 2023
1 parent e671358 commit 6163260
Show file tree
Hide file tree
Showing 11 changed files with 3 additions and 223 deletions.
42 changes: 0 additions & 42 deletions lib/marked.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -1484,9 +1484,6 @@ var _Renderer = class {
}
return '<pre><code class="' + this.options.langPrefix + escape(lang) + '">' + (escaped ? code : escape(code, true)) + "</code></pre>\n";
}
/**
* @param quote
*/
blockquote(quote) {
return `<blockquote>
${quote}</blockquote>
Expand All @@ -1495,12 +1492,6 @@ ${quote}</blockquote>
html(html, block2) {
return html;
}
/**
* @param text
* @param level
* @param raw
* @param slugger
*/
heading(text, level, raw, slugger) {
if (this.options.headerIds) {
const id = this.options.headerPrefix + slugger.slug(raw);
Expand All @@ -1517,35 +1508,22 @@ ${quote}</blockquote>
const type = ordered ? "ol" : "ul", startatt = ordered && start !== 1 ? ' start="' + start + '"' : "";
return "<" + type + startatt + ">\n" + body + "</" + type + ">\n";
}
/**
* @param text
*/
listitem(text, task, checked) {
return `<li>${text}</li>
`;
}
checkbox(checked) {
return "<input " + (checked ? 'checked="" ' : "") + 'disabled="" type="checkbox"' + (this.options.xhtml ? " /" : "") + "> ";
}
/**
* @param text
*/
paragraph(text) {
return `<p>${text}</p>
`;
}
/**
* @param header
* @param body
*/
table(header, body) {
if (body)
body = `<tbody>${body}</tbody>`;
return "<table>\n<thead>\n" + header + "</thead>\n" + body + "</table>\n";
}
/**
* @param content
*/
tablerow(content) {
return `<tr>
${content}</tr>
Expand All @@ -1559,37 +1537,22 @@ ${content}</tr>
}
/**
* span level renderer
* @param text
*/
strong(text) {
return `<strong>${text}</strong>`;
}
/**
* @param text
*/
em(text) {
return `<em>${text}</em>`;
}
/**
* @param text
*/
codespan(text) {
return `<code>${text}</code>`;
}
br() {
return this.options.xhtml ? "<br/>" : "<br>";
}
/**
* @param text
*/
del(text) {
return `<del>${text}</del>`;
}
/**
* @param href
* @param title
* @param text
*/
link(href, title, text) {
href = cleanUrl(this.options.sanitize, this.options.baseUrl, href);
if (href === null) {
Expand All @@ -1602,11 +1565,6 @@ ${content}</tr>
out += ">" + text + "</a>";
return out;
}
/**
* @param href
* @param title
* @param text
*/
image(href, title, text) {
href = cleanUrl(this.options.sanitize, this.options.baseUrl, href);
if (href === null) {
Expand Down
2 changes: 1 addition & 1 deletion lib/marked.cjs.map

Large diffs are not rendered by default.

42 changes: 0 additions & 42 deletions lib/marked.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,71 +162,29 @@ declare class _Renderer {
options: MarkedOptions;
constructor(options?: MarkedOptions);
code(code: string, infostring: string | undefined, escaped: boolean): string;
/**
* @param quote
*/
blockquote(quote: string): string;
html(html: string, block?: boolean): string;
/**
* @param text
* @param level
* @param raw
* @param slugger
*/
heading(text: string, level: number, raw: string, slugger: _Slugger): string;
hr(): string;
list(body: string, ordered: boolean, start: number | ''): string;
/**
* @param text
*/
listitem(text: string, task: boolean, checked: boolean): string;
checkbox(checked: boolean): string;
/**
* @param text
*/
paragraph(text: string): string;
/**
* @param header
* @param body
*/
table(header: string, body: string): string;
/**
* @param content
*/
tablerow(content: string): string;
tablecell(content: string, flags: {
header: boolean;
align: 'center' | 'left' | 'right' | null;
}): string;
/**
* span level renderer
* @param text
*/
strong(text: string): string;
/**
* @param text
*/
em(text: string): string;
/**
* @param text
*/
codespan(text: string): string;
br(): string;
/**
* @param text
*/
del(text: string): string;
/**
* @param href
* @param title
* @param text
*/
link(href: string, title: string | null | undefined, text: string): string;
/**
* @param href
* @param title
* @param text
*/
image(href: string, title: string | null, text: string): string;
text(text: string): string;
}
Expand Down
42 changes: 0 additions & 42 deletions lib/marked.esm.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/marked.esm.js.map

Large diffs are not rendered by default.

42 changes: 0 additions & 42 deletions lib/marked.umd.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/marked.umd.js.map

Large diffs are not rendered by default.

0 comments on commit 6163260

Please sign in to comment.