tag:github.com,2008:https://github.com/jsdoc2md/jsdoc-to-markdown/releases 2024-11-29T15:26:22Z tag:github.com,2008:Repository/19831645/v9.1.1 2024-11-29T15:26:56Z <h2>Non-breaking changes since v9.1.0</h2> <ul> <li>Amended the fix for <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="174931956" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/90" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-to-markdown/issues/90/hovercard" href="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/90">#90</a> so that <code>@link</code>, <code>@linkcode</code> and <code>@linkplain</code> tags are resolved in the <code>@deprecated</code> tag text.</li> </ul> 75lb tag:github.com,2008:Repository/19831645/v9.1.0 2024-11-28T18:55:24Z <h2>New feature since v9.0.5</h2> <ul> <li>Any text passed to the <code>@deprecated</code> tag is now displayed. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="174931956" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/90" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-to-markdown/issues/90/hovercard" href="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/90">#90</a></li> </ul> <h2>Upgrade notes</h2> <p>See this <a href="https://github.com/jsdoc2md/testbed/tree/master/build/jsdoc/global/deprecated">testbed directory</a> for example source code and output.</p> <p>Previously, the tag <code>@deprecated This method has been deprecated since v2.0.0</code> would simply print <code>***Deprecated***</code> in the output, ignoring the deprecation text. The new behaviour:</p> <ul> <li>For an empty <code>@deprecated</code> tag with no text, display <code>***Deprecated***</code> (same as before).</li> <li>If the tag has text, e.g. <code>@deprecated This method has been deprecated since v2.0.0</code>, then the full text line will be printed as written <ul> <li>This will replace the previous <code>***Deprecated***</code> line with <code>***This method has been deprecated since v2.0.0***</code>.</li> <li>This approach gives you full control over the text displayed (without assuming you want the line to begin with "Deprecated").</li> </ul> </li> </ul> 75lb tag:github.com,2008:Repository/19831645/v9.0.5 2024-11-01T23:36:35Z <h2>Non-breaking changes since v9.0.4</h2> <ul> <li>Fixed a regression where spaces in the jsdoc binary path caused jsdoc2md to fail. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2628991247" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/307" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-to-markdown/issues/307/hovercard" href="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/307">#307</a></li> </ul> 75lb tag:github.com,2008:Repository/19831645/v9.0.4 2024-10-19T21:35:43Z <h2>Non-breaking change</h2> <ul> <li>Implemented a permanent fix for the critical <code>util.isRegExp is not a function</code> issue in Node v23, replacing the previous temporary workaround. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2597949712" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/306" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-to-markdown/issues/306/hovercard" href="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/306">#306</a></li> </ul> 75lb tag:github.com,2008:Repository/19831645/v9.0.3 2024-10-19T13:24:28Z <h2>Non-breaking change</h2> <ul> <li>Temporary workaround fix for critical <code>util.isRegExp is not a function</code> issue in Node v23: <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2597949712" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/306" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-to-markdown/issues/306/hovercard" href="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/306">#306</a></li> </ul> 75lb tag:github.com,2008:Repository/19831645/v9.0.2 2024-09-25T16:26:15Z <h2>Non-breaking</h2> <ul> <li>Fixed a scenario where <code>--EOL</code> failed to correctly replace naked CR characters created by jsdoc. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2548144664" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/dmd/issues/102" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/dmd/issues/102/hovercard" href="https://github.com/jsdoc2md/dmd/issues/102">jsdoc2md/dmd#102</a></li> </ul> 75lb tag:github.com,2008:Repository/19831645/v9.0.1 2024-09-08T11:54:35Z <p>9.0.1</p> 75lb tag:github.com,2008:Repository/19831645/v9.0.0 2024-09-01T14:36:07Z <p>The default output has not changed. The minimum required Node version is still v12.17. The goals for this release were bug fixing and simplification. Feel free to comment in the <a href="https://github.com/jsdoc2md/jsdoc-to-markdown/discussions/305" data-hovercard-type="discussion" data-hovercard-url="/jsdoc2md/jsdoc-to-markdown/discussions/305/hovercard">release discussion</a> or post an issue.</p> <h2>Breaking changes since v8.0.3</h2> <ul> <li>Removed <code>.renderSync()</code>, <code>.getTemplateDataSync()</code> and <code>.getJsdocDataSync()</code>. The jsdoc2md API is now async-only.</li> <li>Previously, passing either <code>option.files</code> or <code>option.source</code> was mandatory. Now, it is either <code>option.files</code>, <code>option.source</code> or <code>option.configure</code>. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="1798137292" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-api/issues/27" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-api/issues/27/hovercard" href="https://github.com/jsdoc2md/jsdoc-api/issues/27">jsdoc2md/jsdoc-api#27</a></li> </ul> <h2>Non-breaking changes</h2> <ul> <li>Fixed a bug where it was possible for a handlebars template to be passed into the jsdoc-api <code>template</code> option. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2494248338" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/303" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-to-markdown/issues/303/hovercard" href="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/303">#303</a></li> <li>Support clever-links, monospace-links, <code>{@linkcode}</code> and <code>{@linkplain}</code>. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2459791368" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/301" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-to-markdown/issues/301/hovercard" href="https://github.com/jsdoc2md/jsdoc-to-markdown/issues/301">#301</a></li> <li>Fixed a 'maximum call stack size exceeded' error. The user now gets a warning if the malformed input which formerly caused the error is detected. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2489203580" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/dmd/issues/89" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/dmd/issues/89/hovercard" href="https://github.com/jsdoc2md/dmd/issues/89">jsdoc2md/dmd#89</a></li> <li>Fixed an issue where the dmd internal partials failed to load if a user's directory name contained special glob characters. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="671584166" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/dmd/issues/82" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/dmd/issues/82/hovercard" href="https://github.com/jsdoc2md/dmd/issues/82">jsdoc2md/dmd#82</a></li> <li>Added the <code>--EOL</code> option to control line-endings. Fixes <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2497689369" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/dmd/issues/92" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/dmd/issues/92/hovercard" href="https://github.com/jsdoc2md/dmd/issues/92">jsdoc2md/dmd#92</a>.</li> <li>Fixed an issue where setting <code>{ pedantic: false }</code> confused the underlying jsdoc. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="641198744" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-api/issues/22" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-api/issues/22/hovercard" href="https://github.com/jsdoc2md/jsdoc-api/issues/22">jsdoc2md/jsdoc-api#22</a></li> <li>Can now pass an array of strings to <code>.source</code>. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="272915197" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-api/issues/11" data-hovercard-type="pull_request" data-hovercard-url="/jsdoc2md/jsdoc-api/pull/11/hovercard" href="https://github.com/jsdoc2md/jsdoc-api/pull/11">jsdoc2md/jsdoc-api#11</a></li> <li>Added support for <code>@hideconstructor</code>. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2499102544" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/dmd/issues/94" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/dmd/issues/94/hovercard" href="https://github.com/jsdoc2md/dmd/issues/94">jsdoc2md/dmd#94</a></li> <li>Print a warning when the most common mistake is detected (<code>@module</code> tag required) <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="2499441238" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/dmd/issues/96" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/dmd/issues/96/hovercard" href="https://github.com/jsdoc2md/dmd/issues/96">jsdoc2md/dmd#96</a></li> <li>Fixed an issue where a <code>@example</code> was excluded in the output if the doclet did not contain a description. <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="282725359" data-permission-text="Title is private" data-url="https://github.com/jsdoc2md/jsdoc-parse/issues/33" data-hovercard-type="issue" data-hovercard-url="/jsdoc2md/jsdoc-parse/issues/33/hovercard" href="https://github.com/jsdoc2md/jsdoc-parse/issues/33">jsdoc2md/jsdoc-parse#33</a></li> </ul> <h2>Other improvements</h2> <ul> <li>Greatly optimised the dependency tree - upgraded all deps to their latest versions (removing deprecation warnings) and factored many old modules out of the project.</li> </ul> <h2>Upgrade notes</h2> <ul> <li>Update your code replacing any use of <code>.renderSync()</code>, <code>.getTemplateDataSync()</code> and <code>.getJsdocDataSync()</code> with their async equivalents. <ul> <li>To see an example of API usage, see <a href="https://github.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-create-one-output-file-per-class">here</a>.</li> </ul> </li> </ul> 75lb tag:github.com,2008:Repository/19831645/v9.0.0-5 2024-08-30T21:58:57Z <p>9.0.0-5</p> 75lb tag:github.com,2008:Repository/19831645/v9.0.0-4 2024-08-30T18:18:12Z <p>9.0.0-4</p> 75lb