This repository has been archived by the owner on Apr 30, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 40
/
DocumentationParser.cs
179 lines (166 loc) · 7.43 KB
/
DocumentationParser.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
using SharpDox.Model.Documentation;
using SharpDox.Model.Documentation.Token;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Text.RegularExpressions;
using System.Xml.Linq;
using Microsoft.CodeAnalysis;
namespace SharpDox.Build.Roslyn.Parser
{
internal class DocumentationParser
{
public SDLanguageItemCollection<SDDocumentation> ParseDocumentation(ISymbol symbol)
{
var documentationXml = symbol.GetDocumentationCommentXml();
var docDic = new SDLanguageItemCollection<SDDocumentation>();
if (!string.IsNullOrEmpty(documentationXml))
{
var xml = XDocument.Parse($"<doc>{documentationXml}</doc>");
foreach (var child in xml.Descendants())
{
if (CultureInfo.GetCultures(CultureTypes.NeutralCultures).Any(c => c.TwoLetterISOLanguageName == child.Name.LocalName.ToLower()) || child.Name.LocalName.ToLower() == "default")
{
// TODO
//_sdRepository.AddDocumentationLanguage(child.Name.ToLower());
var languageDoc = ParseDocumentation(child.Descendants(), true);
docDic.Add(child.Name.LocalName.ToLower(), languageDoc);
}
}
//Es wurde keine Sprachunterstützung in der Doku genutzt.
//Deswegen wird die Doku einfach als "default" geladen.
if (docDic.Count == 0)
{
var defaultDoc = ParseDocumentation(xml.Descendants());
docDic.Add("default", defaultDoc);
}
}
return docDic;
}
private SDDocumentation ParseDocumentation(IEnumerable<XElement> docElements, bool multilang = false)
{
var sdDocumentation = new SDDocumentation();
foreach (var child in docElements)
{
switch (child.Name.LocalName.ToLower())
{
case "typeparam":
var typeparamKey = child.Attribute("name")?.Value ?? "typeparam";
if (!sdDocumentation.TypeParams.ContainsKey(typeparamKey))
sdDocumentation.TypeParams.Add(typeparamKey, ParseContentTokens(child, multilang));
break;
case "param":
var paramKey = child.Attribute("name")?.Value ?? "param";
if (!sdDocumentation.Params.ContainsKey(paramKey))
sdDocumentation.Params.Add(paramKey, ParseContentTokens(child, multilang));
break;
case "exception":
var exKey = child.Attribute("cref")?.Value ?? "exception";
if (!sdDocumentation.Exceptions.ContainsKey(exKey))
sdDocumentation.Exceptions.Add(exKey, ParseContentTokens(child, multilang));
break;
case "summary":
sdDocumentation.Summary = ParseContentTokens(child, multilang);
break;
case "remarks":
sdDocumentation.Remarks = ParseContentTokens(child, multilang);
break;
case "example":
sdDocumentation.Example = ParseContentTokens(child, multilang);
break;
case "returns":
AddResultsSection(sdDocumentation.Returns, child, multilang);
break;
case "seealso":
sdDocumentation.SeeAlsos.Add(GetSeeRef(child));
break;
}
}
return sdDocumentation;
}
private SDTokenList ParseContentTokens(XElement xmlElement, bool multilang)
{
var content = new SDTokenList();
foreach (var element in xmlElement.Nodes())
{
var textElement = element as XText;
if(textElement != null)
{
content.Add(new SDToken
{
Role = SDTokenRole.Text,
Text = element.ToString().Trim()
});
}
var nodeElement = element as XElement;
if(nodeElement != null)
{
switch (nodeElement.Name.LocalName.ToLower())
{
case "see":
var seeRef = GetSeeRef(nodeElement);
if (seeRef != null)
{
content.Add(seeRef);
}
break;
case "typeparamref":
content.Add(new SDToken { Role = SDTokenRole.TypeParamRef, Text = nodeElement.Attribute("name")?.Value });
break;
case "paramref":
content.Add(new SDToken { Role = SDTokenRole.ParamRef, Text = nodeElement.Attribute("name")?.Value });
break;
case "code":
content.Add(new SDCodeToken { Text = nodeElement.Value, IsInline = false });
break;
case "c":
content.Add(new SDCodeToken { Text = nodeElement.Value, IsInline = true });
break;
case "para":
content.Add(new SDToken { Text = nodeElement.Value, Role = SDTokenRole.Paragraph });
break;
}
}
}
return content;
}
private void AddResultsSection(Dictionary<string, SDTokenList> results, XElement xmlElement, bool multilang)
{
if (!string.IsNullOrEmpty(xmlElement.Attribute("httpCode")?.Value))
{
results.Add(xmlElement.Attribute("httpCode")?.Value, ParseContentTokens(xmlElement, multilang));
}
else if(!results.ContainsKey("default"))
{
results.Add("default", ParseContentTokens(xmlElement, multilang));
}
}
private SDToken GetSeeRef(XElement xmlElement)
{
try
{
var sdToken = new SDSeeToken();
/*if (xmlElement.ReferencedEntity != null)
{
var identifier = xmlElement.ReferencedEntity.DeclaringType != null
? xmlElement.ReferencedEntity.DeclaringType.GetIdentifier()
: string.Empty;
sdToken.Name = xmlElement.ReferencedEntity.Name;
sdToken.Namespace = xmlElement.ReferencedEntity.Namespace;
sdToken.DeclaringType = identifier;
sdToken.Text = xmlElement.ReferencedEntity.Name;
}
else
{
sdToken.Name = xmlElement.GetAttribute("cref");
}*/
return sdToken;
}
catch (Exception)
{
return null;
}
}
}
}