averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-14 20:36:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add a Requires field to doc comments

Browse Source 
rdar://problem/20902140

Swift SVN r28446
This commit is contained in:
David Farler
2015-05-11 22:52:34 +00:00
parent 296f0c9075
commit b29220a27e
5 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
bindings/xml/comment-xml-schema.rng
View File

@@ -507,6 +507,14 @@
</element> </element>
</define> </define>
<define name="Requires">
<element name="Requires">
<zeroOrMore>
<ref name="BlockContent"/>
</zeroOrMore>
</element>
</define>
<define name="See"> <define name="See">
<element name="See"> <element name="See">
<zeroOrMore> <zeroOrMore>
@@ -715,6 +723,7 @@
<ref name="Precondition"/> <ref name="Precondition"/>
<ref name="Remark"/> <ref name="Remark"/>
<ref name="Remarks"/> <ref name="Remarks"/>
<ref name="Requires"/>
<ref name="See"/> <ref name="See"/>
<ref name="Since"/> <ref name="Since"/>
<ref name="TODO"/> <ref name="TODO"/>

1
docs/DocumentationComments.rst
View File

@@ -80,6 +80,7 @@ one is supported and appear in order inside QuickHelp.
- Precondition: ... - Precondition: ...
- Remark: ... - Remark: ...
- Remarks: ... - Remarks: ...
- Requires: ...
- See: ... - See: ...
- Since: ... - Since: ...
- Todo: ... - Todo: ...

1
include/swift/Markup/ASTNodes.def
View File

@@ -67,6 +67,7 @@ MARKUP_AST_NODE(PrivateExtension, MarkupASTNode)
MARKUP_AST_NODE(RemarkField, PrivateExtension) MARKUP_AST_NODE(RemarkField, PrivateExtension)
MARKUP_AST_NODE(RemarksField, PrivateExtension) MARKUP_AST_NODE(RemarksField, PrivateExtension)
MARKUP_AST_NODE(ReturnsField, PrivateExtension) MARKUP_AST_NODE(ReturnsField, PrivateExtension)
MARKUP_AST_NODE(RequiresField, PrivateExtension)
MARKUP_AST_NODE(SeeField, PrivateExtension) MARKUP_AST_NODE(SeeField, PrivateExtension)
MARKUP_AST_NODE(SinceField, PrivateExtension) MARKUP_AST_NODE(SinceField, PrivateExtension)
MARKUP_AST_NODE(TODOField, PrivateExtension) MARKUP_AST_NODE(TODOField, PrivateExtension)

1
include/swift/Markup/SimpleFields.def
View File

@@ -37,6 +37,7 @@ MARKUP_SIMPLE_FIELD(PreconditionField, precondition, Precondition)
MARKUP_SIMPLE_FIELD(RemarkField, remark, Remark) MARKUP_SIMPLE_FIELD(RemarkField, remark, Remark)
MARKUP_SIMPLE_FIELD(RemarksField, remarks, Remarks) MARKUP_SIMPLE_FIELD(RemarksField, remarks, Remarks)
MARKUP_SIMPLE_FIELD(ReturnsField, returns, Returns) MARKUP_SIMPLE_FIELD(ReturnsField, returns, Returns)
MARKUP_SIMPLE_FIELD(RequiresField, requires, Requires)
MARKUP_SIMPLE_FIELD(SeeField, seealso, See) MARKUP_SIMPLE_FIELD(SeeField, seealso, See)
MARKUP_SIMPLE_FIELD(SinceField, since, Since) MARKUP_SIMPLE_FIELD(SinceField, since, Since)
MARKUP_SIMPLE_FIELD(TODOField, todo, TODO) MARKUP_SIMPLE_FIELD(TODOField, todo, TODO)

5
test/IDE/comment_extensions.swift
View File

@@ -67,6 +67,11 @@ func remark() {}
func remarks() {} func remarks() {}
// CHECK: {{.*}}DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>remarks()</Name><USR>s:F14swift_ide_test7remarksFT_T_</USR><Declaration>func remarks()</Declaration><Discussion><Remarks><Para></Para><List-Bullet><Item><Para>Never let a bear approach you.</Para></Item></List-Bullet></Remarks></Discussion></Function>] // CHECK: {{.*}}DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>remarks()</Name><USR>s:F14swift_ide_test7remarksFT_T_</USR><Declaration>func remarks()</Declaration><Discussion><Remarks><Para></Para><List-Bullet><Item><Para>Never let a bear approach you.</Para></Item></List-Bullet></Remarks></Discussion></Function>]
/// - requires:
/// - explicit package name. Just kidding!
func requires() {}
// CHECK: {{.*}}DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>requires()</Name><USR>s:F14swift_ide_test8requiresFT_T_</USR><Declaration>func requires()</Declaration><Discussion><Requires><Para></Para><List-Bullet><Item><Para>explicit package name. Just kidding!</Para></Item></List-Bullet></Requires></Discussion></Function>]
/// - seealso: the pie (it's very good). /// - seealso: the pie (it's very good).
func see() {} func see() {}
// CHECK: {{.*}}DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>see()</Name><USR>s:F14swift_ide_test3seeFT_T_</USR><Declaration>func see()</Declaration><Discussion><See><Para>the pie (it&apos;s very good).</Para></See></Discussion></Function>] // CHECK: {{.*}}DocCommentAsXML=[<Function file="{{.*}}" line="{{.*}}" column="{{.*}}"><Name>see()</Name><USR>s:F14swift_ide_test3seeFT_T_</USR><Declaration>func see()</Declaration><Discussion><See><Para>the pie (it&apos;s very good).</Para></See></Discussion></Function>]