You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>JSDoc also searches for JSON files that contain information about the titles, ordering, and hierarchy of your tutorials, as discussed in the following section.</p>
65
65
<p>JSDoc assigns an identifier to each tutorial. The identifier is the filename without its extension. For example, the identifier for <code>/path/to/tutorials/overview.md</code> is <code>overview</code>.</p>
66
-
<p>In tutorial files, you can use the <ahref="tags-inline-link.html"><code>{@link}</code></a> and <ahref="tags-inline-tutorial.html"><code>{@tutorial}</code></a> inline tags to link to other parts of the documentation. JSDoc will automatically resolve the links.</p>
66
+
<p>In tutorial files, you can use the <ahref="tags-inline-link.html"><code>{@link}</code></a> and
67
+
<ahref="tags-inline-tutorial.html"><code>{@tutorial}</code></a> inline tags to link to other parts of the documentation. JSDoc will automatically resolve
68
+
the links.</p>
67
69
<h2id="configuring-titles-order-and-hierarchy">Configuring titles, order, and hierarchy</h2>
68
70
<p>By default, JSDoc uses the filename as the tutorial's title, and all tutorials are at the same level. You can use a JSON file to provide a title for each
69
71
tutorial and indicates how the tutorials should be sorted and grouped in the documentation.</p>
@@ -121,8 +123,8 @@ <h2 id="configuring-titles-order-and-hierarchy">Configuring titles, order, and h
121
123
<h2id="linking-to-tutorials-from-api-documentation">Linking to tutorials from API documentation</h2>
122
124
<p>There are multiple ways to link to a tutorial from your API documentation:</p>
<p>If you include a <ahref="tags-inline-tutorial.html"><code>@tutorial</code> block tag</a> in a JSDoc comment, the generated documentation will include a link
125
-
to the tutorial you specify.</p>
126
+
<p>If you include a <ahref="tags-tutorial.html"><code>@tutorial</code> block tag</a> in a JSDoc comment, the generated documentation will include a link to the
127
+
tutorial you specify.</p>
126
128
<figure>
127
129
<figcaption>Using the <code>@tutorial</code> block tag</figcaption><preclass="prettyprint lang-js"><code>/**
0 commit comments