Skip to content

Commit 46f7556

Browse files
committed
enables Snippet directive code for documentation, and updates the generated symbolgraph with that change
1 parent 1028e82 commit 46f7556

File tree

2 files changed

+156
-2
lines changed

2 files changed

+156
-2
lines changed

Sources/SwiftDocC/Semantics/Snippets/Snippet.swift

-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ public final class Snippet: Semantic, AutomaticDirectiveConvertible {
3030
"slice" : \Snippet._slice,
3131
]
3232

33-
static var hiddenFromDocumentation = true
34-
3533
@available(*, deprecated, message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'.")
3634
init(originalMarkup: BlockDirective) {
3735
self.originalMarkup = originalMarkup

Sources/docc/DocCDocumentation.docc/DocC.symbols.json

+156
Original file line numberDiff line numberDiff line change
@@ -5246,6 +5246,162 @@
52465246
"Small"
52475247
]
52485248
},
5249+
{
5250+
"accessLevel" : "public",
5251+
"availability" : [
5252+
{
5253+
"domain" : "Swift-DocC",
5254+
"introduced" : {
5255+
"major" : 5,
5256+
"minor" : 6,
5257+
"patch" : 0
5258+
}
5259+
}
5260+
],
5261+
"declarationFragments" : [
5262+
{
5263+
"kind" : "typeIdentifier",
5264+
"spelling" : "@"
5265+
},
5266+
{
5267+
"kind" : "typeIdentifier",
5268+
"spelling" : "Snippet"
5269+
},
5270+
{
5271+
"kind" : "text",
5272+
"spelling" : "("
5273+
},
5274+
{
5275+
"kind" : "identifier",
5276+
"spelling" : "path"
5277+
},
5278+
{
5279+
"kind" : "text",
5280+
"spelling" : ": "
5281+
},
5282+
{
5283+
"kind" : "typeIdentifier",
5284+
"spelling" : "String"
5285+
},
5286+
{
5287+
"kind" : "text",
5288+
"spelling" : ", "
5289+
},
5290+
{
5291+
"kind" : "identifier",
5292+
"spelling" : "slice"
5293+
},
5294+
{
5295+
"kind" : "text",
5296+
"spelling" : ": "
5297+
},
5298+
{
5299+
"kind" : "typeIdentifier",
5300+
"spelling" : "String"
5301+
},
5302+
{
5303+
"kind" : "text",
5304+
"spelling" : "?"
5305+
},
5306+
{
5307+
"kind" : "text",
5308+
"spelling" : ")"
5309+
}
5310+
],
5311+
"docComment" : {
5312+
"lines" : [
5313+
{
5314+
"text" : "- Parameters:"
5315+
},
5316+
{
5317+
"text" : " - path: The path components of a symbol link that would be used to resolve a reference to a snippet,"
5318+
},
5319+
{
5320+
"text" : " only occurring as a block directive argument."
5321+
},
5322+
{
5323+
"text" : " **(required)**"
5324+
},
5325+
{
5326+
"text" : " - slice: An optional named range to limit the lines shown."
5327+
},
5328+
{
5329+
"text" : " **(optional)**"
5330+
}
5331+
]
5332+
},
5333+
"identifier" : {
5334+
"interfaceLanguage" : "swift",
5335+
"precise" : "__docc_universal_symbol_reference_$Snippet"
5336+
},
5337+
"kind" : {
5338+
"displayName" : "Directive",
5339+
"identifier" : "class"
5340+
},
5341+
"names" : {
5342+
"navigator" : [
5343+
{
5344+
"kind" : "attribute",
5345+
"spelling" : "@"
5346+
},
5347+
{
5348+
"kind" : "identifier",
5349+
"preciseIdentifier" : "__docc_universal_symbol_reference_$Snippet",
5350+
"spelling" : "Snippet"
5351+
}
5352+
],
5353+
"subHeading" : [
5354+
{
5355+
"kind" : "identifier",
5356+
"spelling" : "@"
5357+
},
5358+
{
5359+
"kind" : "identifier",
5360+
"spelling" : "Snippet"
5361+
},
5362+
{
5363+
"kind" : "text",
5364+
"spelling" : "("
5365+
},
5366+
{
5367+
"kind" : "identifier",
5368+
"spelling" : "path"
5369+
},
5370+
{
5371+
"kind" : "text",
5372+
"spelling" : ": "
5373+
},
5374+
{
5375+
"kind" : "typeIdentifier",
5376+
"spelling" : "String"
5377+
},
5378+
{
5379+
"kind" : "text",
5380+
"spelling" : ", "
5381+
},
5382+
{
5383+
"kind" : "identifier",
5384+
"spelling" : "slice"
5385+
},
5386+
{
5387+
"kind" : "text",
5388+
"spelling" : ": "
5389+
},
5390+
{
5391+
"kind" : "typeIdentifier",
5392+
"spelling" : "String"
5393+
},
5394+
{
5395+
"kind" : "text",
5396+
"spelling" : ")"
5397+
}
5398+
],
5399+
"title" : "Snippet"
5400+
},
5401+
"pathComponents" : [
5402+
"Snippet"
5403+
]
5404+
},
52495405
{
52505406
"accessLevel" : "public",
52515407
"availability" : [

0 commit comments

Comments
 (0)