Skip to content

Commit 405ef94

Browse files
committed
Merge pull request #17 from red-gate/NoneOutputType
Display None for void output type.
2 parents 8404e73 + dee3456 commit 405ef94

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

XmlDoc2CmdletDoc.Core/Engine.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ private XElement GenerateReturnValuesElement(ICommentReader commentReader, Comma
500500
var returnValueElement = new XElement(commandNs + "returnValues");
501501
foreach (var type in command.OutputTypes)
502502
{
503-
returnValueElement.Add(GenerateComment("OutputType: " + type.Name));
503+
returnValueElement.Add(GenerateComment("OutputType: " + (type == typeof(void) ? "None" : type.Name)));
504504
var returnValueDescription = commentReader.GetOutputTypeDescriptionElement(command, type, reportWarning);
505505
returnValueElement.Add(new XElement(commandNs + "returnValue",
506506
GenerateTypeElement(commentReader, type, returnValueDescription == null, reportWarning),
@@ -558,7 +558,7 @@ private XElement GenerateRelatedLinksElement(ICommentReader commentReader, Comma
558558
private XElement GenerateTypeElement(ICommentReader commentReader, Type type, bool includeMamlDescription, ReportWarning reportWarning)
559559
{
560560
return new XElement(devNs + "type",
561-
new XElement(mamlNs + "name", type.FullName),
561+
new XElement(mamlNs + "name", type == typeof(void) ? "None" : type.FullName),
562562
new XElement(mamlNs + "uri"),
563563
includeMamlDescription ? commentReader.GetTypeDescriptionElement(type, reportWarning) : null);
564564
}

XmlDoc2CmdletDoc.TestModule/Manual/TestManualElementsCommand.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ namespace XmlDoc2CmdletDoc.TestModule.Manual
5454
[Cmdlet(VerbsDiagnostic.Test, "ManualElements")]
5555
[OutputType(typeof(ManualClass))]
5656
[OutputType(typeof(string))]
57+
[OutputType(typeof(void))]
5758
public class TestManualElementsCommand : Cmdlet
5859
{
5960
public enum Importance

XmlDoc2CmdletDoc.Tests/AcceptanceTests.cs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -606,16 +606,22 @@ public void Command_ReturnValues_ForTestManualElements()
606606
.XPathSelectElements("command:returnValues/command:returnValue", resolver)
607607
.ToList();
608608
Assert.That(returnValues, Is.Not.Empty);
609-
Assert.That(returnValues.Count, Is.EqualTo(2));
609+
Assert.That(returnValues.Count, Is.EqualTo(3));
610610

611611
{
612-
var returnValue = returnValues.First();
612+
var returnValue = returnValues[0];
613613
var name = returnValue.XPathSelectElement("dev:type/maml:name", resolver);
614614
Assert.That(name.Value, Is.EqualTo(typeof(string).FullName));
615615
}
616616

617617
{
618-
var returnValue = returnValues.Last();
618+
var returnValue = returnValues[1];
619+
var name = returnValue.XPathSelectElement("dev:type/maml:name", resolver);
620+
Assert.That(name.Value, Is.EqualTo("None"));
621+
}
622+
623+
{
624+
var returnValue = returnValues[2];
619625
var type = returnValue.XPathSelectElement("dev:type", resolver);
620626
CheckManualClassType(type, false);
621627

0 commit comments

Comments
 (0)