Skip to content

Quickhelp xml swift 4.0 branch #8894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 21, 2017
Merged

Quickhelp xml swift 4.0 branch #8894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
276146f
Updated quick help XML to separate the comment data from the metadata
mxswd Apr 17, 2017
a04fee7
Updated to tests to match commit 452e535ba491897cbbc8a0ba8d7015ef37ea…
mxswd Apr 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
326 changes: 175 additions & 151 deletions bindings/xml/comment-xml-schema.rng
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,26 @@
<optional>
<ref name="Declaration" />
</optional>
<optional>
<ref name="Abstract" />
</optional>
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<optional>
<ref name="Discussion" />
</optional>
<element name="CommentParts">
<optional>
<ref name="Abstract" />
</optional>
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<optional>
<ref name="Discussion" />
</optional>
</element>
</element>
</define>

Expand Down Expand Up @@ -84,36 +86,40 @@
<optional>
<ref name="Declaration" />
</optional>
<optional>
<ref name="Abstract" />
</optional>
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="Exceptions" />
</optional>
<zeroOrMore>
<ref name="Availability" />
</zeroOrMore>
<zeroOrMore>
<ref name="Deprecated" />
</zeroOrMore>
<zeroOrMore>
<ref name="Unavailable" />
</zeroOrMore>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<optional>
<ref name="Discussion" />
</optional>

<element name="CommentParts">
<optional>
<ref name="Abstract" />
</optional>
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="Exceptions" />
</optional>
<zeroOrMore>
<ref name="Availability" />
</zeroOrMore>
<zeroOrMore>
<ref name="Deprecated" />
</zeroOrMore>
<zeroOrMore>
<ref name="Unavailable" />
</zeroOrMore>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<optional>
<ref name="Discussion" />
</optional>
</element>

</element>
</define>

Expand All @@ -140,28 +146,32 @@
<optional>
<ref name="Declaration" />
</optional>
<optional>
<ref name="Abstract" />
</optional>
<optional>
<ref name="TemplateParameters" />
</optional>

<!-- Parameters and results don't make sense for classes, but the user
can specify \param or \returns in a comment anyway. -->
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<element name="CommentParts">
<optional>
<ref name="Abstract" />
</optional>
<optional>
<ref name="TemplateParameters" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
<!-- Parameters and results don't make sense for classes, but the user
can specify \param or \returns in a comment anyway. -->
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
</element>

</element>
</define>

Expand All @@ -178,29 +188,32 @@
<optional>
<ref name="Declaration" />
</optional>
<optional>
<ref name="Abstract" />
</optional>

<!-- Template parameters, parameters and results don't make sense for
variables, but the user can specify \tparam \param or \returns
in a comment anyway. -->
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<element name="CommentParts">
<optional>
<ref name="Abstract" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
<!-- Template parameters, parameters and results don't make sense for
variables, but the user can specify \tparam \param or \returns
in a comment anyway. -->
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
</element>
</element>
</define>

Expand All @@ -217,29 +230,33 @@
<optional>
<ref name="Declaration" />
</optional>
<optional>
<ref name="Abstract" />
</optional>


<!-- Template parameters, parameters and results don't make sense for
namespaces, but the user can specify \tparam, \param or \returns
in a comment anyway. -->
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<element name="CommentParts">
<optional>
<ref name="Abstract" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
<!-- Template parameters, parameters and results don't make sense for
namespaces, but the user can specify \tparam, \param or \returns
in a comment anyway. -->
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
</element>
</element>
</define>

Expand All @@ -256,29 +273,32 @@
<optional>
<ref name="Declaration" />
</optional>
<optional>
<ref name="Abstract" />
</optional>

<optional>
<ref name="TemplateParameters" />
</optional>
<element name="CommentParts">
<optional>
<ref name="Abstract" />
</optional>

<!-- Parameters and results might make sense for typedefs if the type is
a function pointer type. -->
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<optional>
<ref name="TemplateParameters" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
<!-- Parameters and results might make sense for typedefs if the type is
a function pointer type. -->
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
</element>
</element>
</define>

Expand All @@ -295,29 +315,33 @@
<optional>
<ref name="Declaration" />
</optional>
<optional>
<ref name="Abstract" />
</optional>


<!-- Template parameters, parameters and results don't make sense for
enums, but the user can specify \tparam \param or \returns in a
comment anyway. -->
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>
<element name="CommentParts">
<optional>
<ref name="Abstract" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
<!-- Template parameters, parameters and results don't make sense for
enums, but the user can specify \tparam \param or \returns in a
comment anyway. -->
<optional>
<ref name="TemplateParameters" />
</optional>
<optional>
<ref name="Parameters" />
</optional>
<optional>
<ref name="ThrowsDiscussion" />
</optional>
<optional>
<ref name="ResultDiscussion" />
</optional>

<optional>
<ref name="Discussion" />
</optional>
</element>
</element>
</define>

Expand Down
4 changes: 3 additions & 1 deletion lib/IDE/CommentConversion.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,8 +354,10 @@ void CommentToXMLConverter::visitDocComment(const DocComment *DC) {
appendWithXMLEscaping(OS, DeclSS);
OS << "</Declaration>";
}


OS << "<CommentParts>";
visitCommentParts(DC->getParts());
OS << "</CommentParts>";

OS << RootEndTag;
}
Expand Down
Loading