From a71ea5c3fbaa2ffcd6411996d66586ee544653b5 Mon Sep 17 00:00:00 2001 From: Nick Reilingh Date: Mon, 18 Nov 2024 11:57:08 -0500 Subject: [PATCH 1/2] tags-example.md: HTML entities not needed in source This is a markdown code block, so manually escaping HTML entities is incorrect as they will just be re-escaped. --- content/tags-example.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/tags-example.md b/content/tags-example.md index 3fab33e..8916962 100644 --- a/content/tags-example.md +++ b/content/tags-example.md @@ -40,7 +40,7 @@ Examples can also be captioned using `` after the @example ta ```js /** * Solves equations of the form a * x = b - * @example <caption>Example usage of method1.</caption> + * @example Example usage of method1. * // returns 2 * globalNS.method1(5, 10); * @returns {Number} Returns the value of x for the equation. From a3ab2118b4010fa0ad7a8d08b71ff6d32a6ae727 Mon Sep 17 00:00:00 2001 From: Nick Reilingh Date: Mon, 18 Nov 2024 12:13:34 -0500 Subject: [PATCH 2/2] Fixed remaining < entity encodes These were added when the SSG did not handle HTML in markdown code blocks properly Eleventy appears to work correctly now --- content/howto-es2015-modules.md | 2 +- content/tags-author.md | 2 +- content/tags-implements.md | 4 ++-- content/tags-inline-link.md | 12 ++++++------ content/tags-inline-tutorial.md | 8 ++++---- content/tags-interface.md | 4 ++-- content/tags-param.md | 2 +- content/tags-type.md | 2 +- 8 files changed, 18 insertions(+), 18 deletions(-) diff --git a/content/howto-es2015-modules.md b/content/howto-es2015-modules.md index 8ed89bc..f9d783b 100644 --- a/content/howto-es2015-modules.md +++ b/content/howto-es2015-modules.md @@ -74,7 +74,7 @@ export { * Get the red, green, and blue values of a color. * @function * @param {string} color - A color, in hexadecimal format. - * @returns {Array.<number>} An array of the red, green, and blue values, + * @returns {Array.} An array of the red, green, and blue values, * each ranging from 0 to 255. */ rgbify as toRgb diff --git a/content/tags-author.md b/content/tags-author.md index b603df1..88633c2 100644 --- a/content/tags-author.md +++ b/content/tags-author.md @@ -25,7 +25,7 @@ address to a `mailto:` link. ```js /** - * @author Jane Smith <jsmith@example.com> + * @author Jane Smith */ function MyClass() {} ``` diff --git a/content/tags-implements.md b/content/tags-implements.md index 47cafe4..1302297 100644 --- a/content/tags-implements.md +++ b/content/tags-implements.md @@ -43,7 +43,7 @@ function Color() {} * Get the color as an array of red, green, and blue values, represented as * decimal numbers between 0 and 1. * - * @returns {Array<number>} An array containing the red, green, and blue values, + * @returns {Array} An array containing the red, green, and blue values, * in that order. */ Color.prototype.rgb = function() { @@ -67,7 +67,7 @@ TransparentColor.prototype.rgb = function() { * Get the color as an array of red, green, blue, and alpha values, represented * as decimal numbers between 0 and 1. * - * @returns {Array<number>} An array containing the red, green, blue, and alpha + * @returns {Array} An array containing the red, green, blue, and alpha * values, in that order. */ TransparentColor.prototype.rgba = function() { diff --git a/content/tags-inline-link.md b/content/tags-inline-link.md index 63efcb3..b6e5c50 100644 --- a/content/tags-inline-link.md +++ b/content/tags-inline-link.md @@ -76,9 +76,9 @@ By default, the example above produces output similar to the following: ::: example "Output for {@link} tags" ```html -See <a href="MyClass.html">MyClass</a> and <a href="MyClass.html#foo">MyClass's foo -property</a>. Also, check out <a href="http://www.google.com">Google</a> and -<a href="https://github.com">GitHub</a>. +See MyClass and MyClass's foo +property. Also, check out Google and +GitHub. ``` ::: @@ -88,8 +88,8 @@ produce the following output: ::: example "Output with clever links enabled" ```html -See <a href="MyClass.html"><code>MyClass</code></a> and <a href="MyClass.html#foo"> -<code>MyClass's foo property</code></a>. Also, check out -<a href="http://www.google.com">Google</a> and <a href="https://github.com">GitHub</a>. +See MyClass and +MyClass's foo property. Also, check out +Google and GitHub. ``` ::: diff --git a/content/tags-inline-tutorial.md b/content/tags-inline-tutorial.md index 2121afd..54dac26 100644 --- a/content/tags-inline-tutorial.md +++ b/content/tags-inline-tutorial.md @@ -49,9 +49,9 @@ Started," the example above produces output similar to the following: ::: example "Output for {@link} tags" ```html -See <a href="tutorial-gettingstarted.html">Getting Started</a> and -<a href="tutorial-dashboard.html">Configuring the Dashboard</a>. -For more information, see <a href="tutorial-create.html">Creating a Widget</a> and -<a href="tutorial-destroy.html">Destroying a Widget</a>. +See Getting Started and +Configuring the Dashboard. +For more information, see Creating a Widget and +Destroying a Widget. ``` ::: diff --git a/content/tags-interface.md b/content/tags-interface.md index 1eba811..292bd1a 100644 --- a/content/tags-interface.md +++ b/content/tags-interface.md @@ -57,7 +57,7 @@ function Color() {} * Get the color as an array of red, green, and blue values, represented as * decimal numbers between 0 and 1. * - * @returns {Array<number>} An array containing the red, green, and blue values, + * @returns {Array} An array containing the red, green, and blue values, * in that order. */ Color.prototype.rgb = function() { @@ -84,7 +84,7 @@ The following example uses virtual comments, rather than code, to define the `Co * * @function * @name Color#rgb - * @returns {Array<number>} An array containing the red, green, and blue values, + * @returns {Array} An array containing the red, green, and blue values, * in that order. */ ``` diff --git a/content/tags-param.md b/content/tags-param.md index e2565fc..a142f6b 100644 --- a/content/tags-param.md +++ b/content/tags-param.md @@ -234,7 +234,7 @@ function sayHello(somebody) { */ function sum(num) { var i = 0, n = arguments.length, t = 0; - for (; i < n; i++) { + for (; i < n; i++) { t += arguments[i]; } return t; diff --git a/content/tags-type.md b/content/tags-type.md index 10f6f07..b84daba 100644 --- a/content/tags-type.md +++ b/content/tags-type.md @@ -220,7 +220,7 @@ documented. */ function sum(num) { var i=0, n=arguments.length, t=0; - for (; i<n; i++) { + for (; i