Skip to content

Commit 776433c

Browse files
authored
Merge pull request #64 from finnoybu/patch-1
broken link to usejsdoc.org
2 parents 3f7d27d + ef61a57 commit 776433c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

inline-documentation-standards/javascript.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JavaScript Documentation Standards
22

3-
WordPress follows the <a href="http://usejsdoc.org/" target="_blank" rel="noopener">JSDoc 3 standard</a> for inline JavaScript documentation.
3+
WordPress follows the <a href="http://jsdoc.app/" target="_blank" rel="noopener">JSDoc 3 standard</a> for inline JavaScript documentation.
44
<h2>What Should Be Documented</h2>
55
JavaScript documentation in WordPress takes the form of either formatted blocks of documentation or inline comments.
66

@@ -88,7 +88,7 @@ Functions should be formatted as follows:
8888
<li><strong>@fires:</strong> Event fired by the function. Events tied to a specific class should list the class name.</li>
8989
<li><strong>@listens:</strong> Events this function listens for. An event must be prefixed with the event namespace. Events tied to a specific class should list the class name.</li>
9090
<li><strong>@global:</strong> Marks this function as a global function to be included in the global namespace.</li>
91-
<li><strong>@param:</strong> Give a brief description of the variable; denote particulars (e.g. if the variable is optional, its default) with <a href="http://usejsdoc.org/tags-param.html">JSDoc @param syntax</a>. Use a period at the end.</li>
91+
<li><strong>@param:</strong> Give a brief description of the variable; denote particulars (e.g. if the variable is optional, its default) with <a href="http://jsdoc.app/tags-param.html">JSDoc @param syntax</a>. Use a period at the end.</li>
9292
<li><strong>@yield:</strong> For <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*">generator functions</a>, a description of the values expected to be yielded from this function. As with other descriptions, include a period at the end.</li>
9393
<li><strong>@return:</strong> Note the period after the description.</li>
9494
</ul>

0 commit comments

Comments
 (0)