Skip to content

Commit be45b48

Browse files
committed
removing section about markdown comments inside snippets
1 parent 8155e11 commit be45b48

File tree

1 file changed

+0
-6
lines changed

1 file changed

+0
-6
lines changed

Sources/docc/DocCDocumentation.docc/adding-code-snippets-to-your-content.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,12 +197,6 @@ Extending the earlier snippet example, the slice `setup` would be referenced wit
197197
@Snippet(path: "my-package/Snippets/example-snippet", slice: "setup")
198198
```
199199

200-
### Documenting the code in your snippet
201-
202-
DocC parses contiguous comments within the code of a snippet as markdown to annotate your code when embedded in documentation.
203-
DocC will attempt to reference symbols from within these comments just like any other documentation content.
204-
You can reference symbols from your API, which DocC converts into hyperlinks to that symbol when displaying the content.
205-
206200
## Topics
207201

208202
### Directives

0 commit comments

Comments
 (0)