Skip to content

Commit 452e535

Browse files
mxswdmxswd
committed
Updated quick help XML to separate the comment data from the metadata
1 parent 4e04061 commit 452e535

File tree

2 files changed

+178
-152
lines changed

2 files changed

+178
-152
lines changed

‎bindings/xml/comment-xml-schema.rng

+175-151
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,26 @@
3030
<optional>
3131
<ref name="Declaration" />
3232
</optional>
33-
<optional>
34-
<ref name="Abstract" />
35-
</optional>
36-
<optional>
37-
<ref name="TemplateParameters" />
38-
</optional>
39-
<optional>
40-
<ref name="Parameters" />
41-
</optional>
42-
<optional>
43-
<ref name="ThrowsDiscussion" />
44-
</optional>
45-
<optional>
46-
<ref name="ResultDiscussion" />
47-
</optional>
48-
<optional>
49-
<ref name="Discussion" />
50-
</optional>
33+
<element name="CommentParts">
34+
<optional>
35+
<ref name="Abstract" />
36+
</optional>
37+
<optional>
38+
<ref name="TemplateParameters" />
39+
</optional>
40+
<optional>
41+
<ref name="Parameters" />
42+
</optional>
43+
<optional>
44+
<ref name="ThrowsDiscussion" />
45+
</optional>
46+
<optional>
47+
<ref name="ResultDiscussion" />
48+
</optional>
49+
<optional>
50+
<ref name="Discussion" />
51+
</optional>
52+
</element>
5153
</element>
5254
</define>
5355

@@ -84,36 +86,40 @@
8486
<optional>
8587
<ref name="Declaration" />
8688
</optional>
87-
<optional>
88-
<ref name="Abstract" />
89-
</optional>
90-
<optional>
91-
<ref name="TemplateParameters" />
92-
</optional>
93-
<optional>
94-
<ref name="Parameters" />
95-
</optional>
96-
<optional>
97-
<ref name="Exceptions" />
98-
</optional>
99-
<zeroOrMore>
100-
<ref name="Availability" />
101-
</zeroOrMore>
102-
<zeroOrMore>
103-
<ref name="Deprecated" />
104-
</zeroOrMore>
105-
<zeroOrMore>
106-
<ref name="Unavailable" />
107-
</zeroOrMore>
108-
<optional>
109-
<ref name="ThrowsDiscussion" />
110-
</optional>
111-
<optional>
112-
<ref name="ResultDiscussion" />
113-
</optional>
114-
<optional>
115-
<ref name="Discussion" />
116-
</optional>
89+
90+
<element name="CommentParts">
91+
<optional>
92+
<ref name="Abstract" />
93+
</optional>
94+
<optional>
95+
<ref name="TemplateParameters" />
96+
</optional>
97+
<optional>
98+
<ref name="Parameters" />
99+
</optional>
100+
<optional>
101+
<ref name="Exceptions" />
102+
</optional>
103+
<zeroOrMore>
104+
<ref name="Availability" />
105+
</zeroOrMore>
106+
<zeroOrMore>
107+
<ref name="Deprecated" />
108+
</zeroOrMore>
109+
<zeroOrMore>
110+
<ref name="Unavailable" />
111+
</zeroOrMore>
112+
<optional>
113+
<ref name="ThrowsDiscussion" />
114+
</optional>
115+
<optional>
116+
<ref name="ResultDiscussion" />
117+
</optional>
118+
<optional>
119+
<ref name="Discussion" />
120+
</optional>
121+
</element>
122+
117123
</element>
118124
</define>
119125

@@ -140,28 +146,32 @@
140146
<optional>
141147
<ref name="Declaration" />
142148
</optional>
143-
<optional>
144-
<ref name="Abstract" />
145-
</optional>
146-
<optional>
147-
<ref name="TemplateParameters" />
148-
</optional>
149149

150-
<!-- Parameters and results don't make sense for classes, but the user
151-
can specify \param or \returns in a comment anyway. -->
152-
<optional>
153-
<ref name="Parameters" />
154-
</optional>
155-
<optional>
156-
<ref name="ThrowsDiscussion" />
157-
</optional>
158-
<optional>
159-
<ref name="ResultDiscussion" />
160-
</optional>
150+
<element name="CommentParts">
151+
<optional>
152+
<ref name="Abstract" />
153+
</optional>
154+
<optional>
155+
<ref name="TemplateParameters" />
156+
</optional>
161157

162-
<optional>
163-
<ref name="Discussion" />
164-
</optional>
158+
<!-- Parameters and results don't make sense for classes, but the user
159+
can specify \param or \returns in a comment anyway. -->
160+
<optional>
161+
<ref name="Parameters" />
162+
</optional>
163+
<optional>
164+
<ref name="ThrowsDiscussion" />
165+
</optional>
166+
<optional>
167+
<ref name="ResultDiscussion" />
168+
</optional>
169+
170+
<optional>
171+
<ref name="Discussion" />
172+
</optional>
173+
</element>
174+
165175
</element>
166176
</define>
167177

@@ -178,29 +188,32 @@
178188
<optional>
179189
<ref name="Declaration" />
180190
</optional>
181-
<optional>
182-
<ref name="Abstract" />
183-
</optional>
184191

185-
<!-- Template parameters, parameters and results don't make sense for
186-
variables, but the user can specify \tparam \param or \returns
187-
in a comment anyway. -->
188-
<optional>
189-
<ref name="TemplateParameters" />
190-
</optional>
191-
<optional>
192-
<ref name="Parameters" />
193-
</optional>
194-
<optional>
195-
<ref name="ThrowsDiscussion" />
196-
</optional>
197-
<optional>
198-
<ref name="ResultDiscussion" />
199-
</optional>
192+
<element name="CommentParts">
193+
<optional>
194+
<ref name="Abstract" />
195+
</optional>
200196

201-
<optional>
202-
<ref name="Discussion" />
203-
</optional>
197+
<!-- Template parameters, parameters and results don't make sense for
198+
variables, but the user can specify \tparam \param or \returns
199+
in a comment anyway. -->
200+
<optional>
201+
<ref name="TemplateParameters" />
202+
</optional>
203+
<optional>
204+
<ref name="Parameters" />
205+
</optional>
206+
<optional>
207+
<ref name="ThrowsDiscussion" />
208+
</optional>
209+
<optional>
210+
<ref name="ResultDiscussion" />
211+
</optional>
212+
213+
<optional>
214+
<ref name="Discussion" />
215+
</optional>
216+
</element>
204217
</element>
205218
</define>
206219

@@ -217,29 +230,33 @@
217230
<optional>
218231
<ref name="Declaration" />
219232
</optional>
220-
<optional>
221-
<ref name="Abstract" />
222-
</optional>
233+
223234

224-
<!-- Template parameters, parameters and results don't make sense for
225-
namespaces, but the user can specify \tparam, \param or \returns
226-
in a comment anyway. -->
227-
<optional>
228-
<ref name="TemplateParameters" />
229-
</optional>
230-
<optional>
231-
<ref name="Parameters" />
232-
</optional>
233-
<optional>
234-
<ref name="ThrowsDiscussion" />
235-
</optional>
236-
<optional>
237-
<ref name="ResultDiscussion" />
238-
</optional>
235+
<element name="CommentParts">
236+
<optional>
237+
<ref name="Abstract" />
238+
</optional>
239239

240-
<optional>
241-
<ref name="Discussion" />
242-
</optional>
240+
<!-- Template parameters, parameters and results don't make sense for
241+
namespaces, but the user can specify \tparam, \param or \returns
242+
in a comment anyway. -->
243+
<optional>
244+
<ref name="TemplateParameters" />
245+
</optional>
246+
<optional>
247+
<ref name="Parameters" />
248+
</optional>
249+
<optional>
250+
<ref name="ThrowsDiscussion" />
251+
</optional>
252+
<optional>
253+
<ref name="ResultDiscussion" />
254+
</optional>
255+
256+
<optional>
257+
<ref name="Discussion" />
258+
</optional>
259+
</element>
243260
</element>
244261
</define>
245262

@@ -256,29 +273,32 @@
256273
<optional>
257274
<ref name="Declaration" />
258275
</optional>
259-
<optional>
260-
<ref name="Abstract" />
261-
</optional>
262276

263-
<optional>
264-
<ref name="TemplateParameters" />
265-
</optional>
277+
<element name="CommentParts">
278+
<optional>
279+
<ref name="Abstract" />
280+
</optional>
266281

267-
<!-- Parameters and results might make sense for typedefs if the type is
268-
a function pointer type. -->
269-
<optional>
270-
<ref name="Parameters" />
271-
</optional>
272-
<optional>
273-
<ref name="ThrowsDiscussion" />
274-
</optional>
275-
<optional>
276-
<ref name="ResultDiscussion" />
277-
</optional>
282+
<optional>
283+
<ref name="TemplateParameters" />
284+
</optional>
278285

279-
<optional>
280-
<ref name="Discussion" />
281-
</optional>
286+
<!-- Parameters and results might make sense for typedefs if the type is
287+
a function pointer type. -->
288+
<optional>
289+
<ref name="Parameters" />
290+
</optional>
291+
<optional>
292+
<ref name="ThrowsDiscussion" />
293+
</optional>
294+
<optional>
295+
<ref name="ResultDiscussion" />
296+
</optional>
297+
298+
<optional>
299+
<ref name="Discussion" />
300+
</optional>
301+
</element>
282302
</element>
283303
</define>
284304

@@ -295,29 +315,33 @@
295315
<optional>
296316
<ref name="Declaration" />
297317
</optional>
298-
<optional>
299-
<ref name="Abstract" />
300-
</optional>
318+
301319

302-
<!-- Template parameters, parameters and results don't make sense for
303-
enums, but the user can specify \tparam \param or \returns in a
304-
comment anyway. -->
305-
<optional>
306-
<ref name="TemplateParameters" />
307-
</optional>
308-
<optional>
309-
<ref name="Parameters" />
310-
</optional>
311-
<optional>
312-
<ref name="ThrowsDiscussion" />
313-
</optional>
314-
<optional>
315-
<ref name="ResultDiscussion" />
316-
</optional>
320+
<element name="CommentParts">
321+
<optional>
322+
<ref name="Abstract" />
323+
</optional>
317324

318-
<optional>
319-
<ref name="Discussion" />
320-
</optional>
325+
<!-- Template parameters, parameters and results don't make sense for
326+
enums, but the user can specify \tparam \param or \returns in a
327+
comment anyway. -->
328+
<optional>
329+
<ref name="TemplateParameters" />
330+
</optional>
331+
<optional>
332+
<ref name="Parameters" />
333+
</optional>
334+
<optional>
335+
<ref name="ThrowsDiscussion" />
336+
</optional>
337+
<optional>
338+
<ref name="ResultDiscussion" />
339+
</optional>
340+
341+
<optional>
342+
<ref name="Discussion" />
343+
</optional>
344+
</element>
321345
</element>
322346
</define>
323347

‎lib/IDE/CommentConversion.cpp

+3-1
Original file line numberDiff line numberDiff line change
@@ -354,8 +354,10 @@ void CommentToXMLConverter::visitDocComment(const DocComment *DC) {
354354
appendWithXMLEscaping(OS, DeclSS);
355355
OS << "</Declaration>";
356356
}
357-
357+
358+
OS << "<CommentParts>";
358359
visitCommentParts(DC->getParts());
360+
OS << "</CommentParts>";
359361

360362
OS << RootEndTag;
361363
}

0 commit comments

Comments
 (0)