Skip to content

Commit

Permalink
Update @includeCode example
Browse files Browse the repository at this point in the history
Ref: #2786
  • Loading branch information
Gerrit0 committed Nov 27, 2024
1 parent 110b081 commit 72b4054
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions site/tags/include.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,16 @@ selecting the syntax highlighting language.
/**
* {@include ./doSomething_docs.md}
*
* Quick start:
* {@includeCode ../examples/doSomethingQuickStart.ts}
*
* @example
* This will only work if the jsdocCompatibility.exampleTag option is false
* {@includeCode ../test/doSomething.test.ts}
*/
function doSomething() {}
```

## See Also

- The [jsdocCompatibility](../options/comments.md#jsdoccompatibility) option.

0 comments on commit 72b4054

Please sign in to comment.