File tree Expand file tree Collapse file tree 1 file changed +4
-4
lines changed Expand file tree Collapse file tree 1 file changed +4
-4
lines changed Original file line number Diff line number Diff line change @@ -49,11 +49,11 @@ See also: [yaml specification](https://yaml.org/spec/1.2.2/) for how to use YAML
4949
5050## Keywords
5151
52- ### ` doc-location `
52+ ### ` doc_location `
5353
5454Rules:
5555
56- 1 . The ` doc-location ` keyword can be used to use content from another file INSTEAD of the doc-comments content.
56+ 1 . The ` doc_location ` keyword can be used to use content from another file INSTEAD of the doc-comments content.
5757
58582 . The value ` file ` must be given as a path relative to the current file.
5959
6363{
6464 /**
6565 ---
66- doc-location : ./path.md
66+ doc_location : ./path.md
6767 ---
6868 */
6969 foo = x: x;
7575some nice docs!
7676```
7777
78- In this example, the ` doc-location ` directive fetches content from ` ./path.md ` treating it as if it were directly within the doc-comment.
78+ In this example, the ` doc_location ` directive fetches content from ` ./path.md ` treating it as if it were directly within the doc-comment.
7979This allows tracking the reference between the source position and the markdown file, in case of external documentation.
8080
8181## Extensibility
You can’t perform that action at this time.
0 commit comments