File tree Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Original file line number Diff line number Diff line change @@ -134,7 +134,7 @@ Not just symbols can be documented. Modules can also be documented. This is
134
134
useful to give an overview of the module and its exported symbols.
135
135
136
136
To document a module, add a JSDoc comment at the top of the module file, and
137
- include the ` @module ` tag anywhere in the comment :
137
+ include the ` @module ` tag after the description :
138
138
139
139
``` diff
140
140
+ /**
@@ -153,8 +153,6 @@ You can also include examples in module documentation:
153
153
154
154
```` diff
155
155
/**
156
- * @module
157
- *
158
156
* This module contains functions to search the database.
159
157
*
160
158
+ * @example
@@ -163,5 +161,11 @@ You can also include examples in module documentation:
163
161
+ *
164
162
+ * search("Alan") // ["Alan Turing", "Alan Kay", ...]
165
163
+ * ```
164
+ *
165
+ * @module
166
166
*/
167
167
````
168
+
169
+ If a default entrypoint has a module documentation, it takes precedence over the
170
+ README file in the "Overview" tab of the package page.
171
+ [ Learn more in the documentation section for packages] ( /docs/packages#documentation ) .
You can’t perform that action at this time.
0 commit comments