Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 15 additions & 10 deletions mdoc/Mono.Documentation/MDocUpdater.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3391,17 +3391,22 @@ private void MakeDocNode (DocsNodeInfo info, IEnumerable<DocumentationImporter>
}
}
else
{
if (DocUtils.NeedsOverwrite(e["returns"]))
{
if (CheckRemoveByImporter("returns"))
ClearElement(e, "returns");
}
if (DocUtils.NeedsOverwrite(e["value"]))
{
var commMemberKeys = new string[] { "returns", "value", "related" };
for (int i = 0; i < commMemberKeys.Length; i++)
{
if (CheckRemoveByImporter("value"))
ClearElement(e, "value");
}
if (DocUtils.NeedsOverwrite(e[commMemberKeys[i]]))
if (DocUtils.CheckRemoveByImporter(info, commMemberKeys[i], importers, setimporters))
ClearElement(e, commMemberKeys[i]);
}

var altMemberKeys = new string[] { "altmember", "seealso" };
for (int i = 0; i < altMemberKeys.Length; i++)
{
if (DocUtils.NeedsOverwrite(e["altmember"]))
if (DocUtils.CheckRemoveByImporter(info, altMemberKeys[i], importers, setimporters))
ClearElement(e, "altmember");
}
}

if (addremarks)
Expand Down
20 changes: 20 additions & 0 deletions mdoc/Mono.Documentation/Updater/DocUtils.cs
Original file line number Diff line number Diff line change
Expand Up @@ -891,5 +891,25 @@ public static List<GenericParameter> GetGenericParameters(TypeDefinition type)
}
return assemblyDelList;
}

public static bool CheckRemoveByImporter(DocsNodeInfo info, string keyName, List<DocumentationImporter> DocImports, IEnumerable<DocumentationImporter> SetImports)
{
foreach (DocumentationImporter i in DocImports)
{
if (i.CheckRemoveByMapping(info, keyName))
return true;
}

if (SetImports != null)
{
foreach (var i in SetImports)
{
if (i.CheckRemoveByMapping(info, keyName))
return true;
}
}

return false;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

namespace Mono.Documentation.Updater
{
class MsxdocDocumentationImporter : DocumentationImporter
public class MsxdocDocumentationImporter : DocumentationImporter
{
XmlDocument slashdocs;
Dictionary<string, XmlNode> slashdocsMapping = new Dictionary<string, XmlNode>();
Expand Down
27 changes: 27 additions & 0 deletions mdoc/mdoc.Test/MDocUpdaterTests.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Xml;
Expand Down Expand Up @@ -156,5 +157,31 @@ private List<XmlElement> UpdateXml(string XmlNodeName, MemberReference mi)

return returnValue;
}

[Test]
public void Update_ImportDoc_Test()
{
List<DocumentationImporter> setimporters = new List<DocumentationImporter>();
List<DocumentationImporter> importers = new List<DocumentationImporter>();
var filePath = Path.Combine(Path.GetDirectoryName(this.GetType().Module.Assembly.Location), "SampleClasses\\testImportDoc.xml");
MsxdocDocumentationImporter importer = new MsxdocDocumentationImporter(
filePath);
setimporters.Add(importer);

XmlDocument doc = new System.Xml.XmlDocument();
doc.LoadXml(XmlConsts.internalEllXml);

var type = GetType(typeof(mdoc.Test2.InternalEIICalss));
var docEnum = new DocumentationEnumerator();

var nodeMember = docEnum.GetDocumentationMembers(doc, type, FrameworkTypeEntry.Empty).FirstOrDefault(t => t.Member.FullName == "System.String mdoc.Test2.InternalEIICalss::Getstring(System.Int32)");

var testKeys = new string[] { "returns", "value", "related", "seealso" };

for (int i = 0; i < testKeys.Length; i++)
{
Assert.IsTrue(DocUtils.CheckRemoveByImporter(nodeMember, testKeys[i], importers, setimporters));
}
}
}
}
17 changes: 17 additions & 0 deletions mdoc/mdoc.Test/SampleClasses/testImportDoc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions mdoc/mdoc.Test/mdoc.Test.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,10 @@
<Link>SampleClasses\cppcli.dll</Link>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
<Content Include="SampleClasses\testImportDoc.xml">
<Link>SampleClasses\testImportDoc.xml</Link>
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</Content>
</ItemGroup>
<ItemGroup />
<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
Expand Down