// Copyright (c) AlphaSierraPapa for the SharpDevelop Team // // Permission is hereby granted, free of charge, to any person obtaining a copy of this // software and associated documentation files (the "Software"), to deal in the Software // without restriction, including without limitation the rights to use, copy, modify, merge, // publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons // to whom the Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in all copies or // substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, // INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE // FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. using System; using System.IO; using System.Linq; using ICSharpCode.NRefactory.CSharp; using ICSharpCode.NRefactory.TypeSystem; using NUnit.Framework; namespace ICSharpCode.NRefactory.Documentation { [TestFixture] public class CSharpDocumentationTests { ICompilation compilation; ITypeDefinition typeDefinition; void Init(string program) { var pc = new CSharpProjectContent().AddAssemblyReferences(new[] { CecilLoaderTests.Mscorlib }); var cu = new CSharpParser().Parse(new StringReader(program), "program.cs"); compilation = pc.UpdateProjectContent(null, cu.ToTypeSystem()).CreateCompilation(); typeDefinition = compilation.MainAssembly.TopLevelTypeDefinitions.FirstOrDefault(); } [Test] public void TypeDocumentationLookup() { Init(@"using System; /// class Test { }"); Assert.AreEqual("", typeDefinition.Documentation.Xml); } [Test] public void TypeDocumentationLookup2() { Init(@"using System; /// /// Documentation /// class Test { }"); Assert.AreEqual("" + Environment.NewLine + "Documentation" + Environment.NewLine + "", typeDefinition.Documentation.Xml); } [Test] public void TypeDocumentationLookupWithIndentation() { Init(@"using System; /// /// Documentation /// class Test { }"); Assert.AreEqual("" + Environment.NewLine + " Documentation" + Environment.NewLine + "", typeDefinition.Documentation.Xml); } [Test] public void MultilineDocumentation() { Init(@"using System; /** Documentation */ class Test { }"); Assert.AreEqual("Documentation", typeDefinition.Documentation.Xml); } [Test] public void MultilineDocumentation2() { Init(@"using System; /** Documentation */ class Test { }"); Assert.AreEqual("" + Environment.NewLine + " Documentation" + Environment.NewLine + "", typeDefinition.Documentation.Xml); } [Test] public void MultilineDocumentationCommonPattern() { Init(@"using System; /** * * Documentation * */ class Test { }"); Assert.AreEqual("" + Environment.NewLine + " Documentation" + Environment.NewLine + "", typeDefinition.Documentation.Xml); } } }