From 378feab9f5574313c72d4a354e036399cdf3422b Mon Sep 17 00:00:00 2001 From: Yufei Huang Date: Sun, 9 Apr 2023 16:29:28 +0800 Subject: [PATCH] fix: xml comment whitespace handling (#8607) --- samples/common/Example.cs | 22 ++ samples/seed/dotnet/project/Project/Class1.cs | 39 ++- .../Parsers/XmlComment.cs | 194 +++++------- .../Parsers/XmlCommentParserContext.cs | 6 +- .../Parsers/XmlCommentTransformer.cs | 4 +- .../Resources/XmlCommentTransform.xsl | 40 +-- .../Visitors/SymbolVisitorAdapter.cs | 50 ++- .../GenerateMetadataFromCSUnitTest.cs | 8 +- .../XmlCommentUnitTest.cs | 285 +++++++++-------- ...CSharp10.Issue7737.html.view.verified.json | 2 +- .../CSharp8.Issue4007.html.view.verified.json | 2 +- .../api/CSharp8.html.view.verified.json | 2 +- ...romAssembly.Class1.html.view.verified.json | 2 +- .../BuildFromAssembly.html.view.verified.json | 2 +- ...ject.Class1.Test-1.html.view.verified.json | 4 +- ...FromProject.Class1.html.view.verified.json | 296 +++++++++++++++++- ...roject.IInheritdoc.html.view.verified.json | 2 +- ...Issue6366.Class1-1.html.view.verified.json | 2 +- ...c.Issue6366.Class2.html.view.verified.json | 2 +- ...heritdoc.Issue7484.html.view.verified.json | 12 +- ...heritdoc.Issue8101.html.view.verified.json | 4 +- ...Project.Inheritdoc.html.view.verified.json | 4 +- .../BuildFromProject.html.view.verified.json | 2 +- ...rceCode.BaseClass1.html.view.verified.json | 2 +- ...BSourceCode.Class1.html.view.verified.json | 8 +- ...ldFromVBSourceCode.html.view.verified.json | 4 +- .../CatLibrary.Cat-2.html.view.verified.json | 34 +- ...sRefType.ColorType.html.view.verified.json | 8 +- ...ersRefTypeDelegate.html.view.verified.json | 2 +- ....ContainersRefType.html.view.verified.json | 8 +- .../CatLibrary.Core.html.view.verified.json | 6 +- ...ary.FakeDelegate-1.html.view.verified.json | 2 +- ...CatLibrary.IAnimal.html.view.verified.json | 12 +- .../CatLibrary.ICat.html.view.verified.json | 12 +- ...rary.ICatExtension.html.view.verified.json | 6 +- ...ary.MRefDelegate-3.html.view.verified.json | 2 +- ...MRefNormalDelegate.html.view.verified.json | 2 +- .../CatLibrary.Tom.html.view.verified.json | 4 +- ...y.TomFromBaseClass.html.view.verified.json | 6 +- .../api/CatLibrary.html.view.verified.json | 18 +- ...meration.ColorType.html.view.verified.json | 8 +- ...f.Demo.Enumeration.html.view.verified.json | 2 +- .../SamplesTest.Seed/index.verified.json | 2 +- .../SamplesTest.Seed/xrefmap.verified.yml | 26 ++ ...-BuildFromProject.Class1.html.verified.png | 4 +- ...-BuildFromProject.Class1.html.verified.png | 4 +- ...i-CatLibrary.Cat-2.html-q-cat.verified.png | 4 +- ...-BuildFromProject.Class1.html.verified.png | 4 +- ...i-CatLibrary.Cat-2.html-q-cat.verified.png | 4 +- ...BuildFromProject.Class1.html.verified.html | 104 +++++- ...-CatLibrary.Cat-2.html-q-cat.verified.html | 22 +- ...api-CatLibrary.html-term-cat.verified.html | 8 +- .../html/api-CatLibrary.html.verified.html | 8 +- 53 files changed, 857 insertions(+), 465 deletions(-) create mode 100644 samples/common/Example.cs diff --git a/samples/common/Example.cs b/samples/common/Example.cs new file mode 100644 index 00000000000..f7010027f5a --- /dev/null +++ b/samples/common/Example.cs @@ -0,0 +1,22 @@ +public class BaseSocketClient +{ + #region MessageDeleted + + public void HookMessageDeleted(BaseSocketClient client) + { + client.MessageDeleted += HandleMessageDelete; + } + + public Task HandleMessageDelete(Cacheable cachedMessage, ISocketMessageChannel channel) + { + // check if the message exists in cache; if not, we cannot report what was removed + if (!cachedMessage.HasValue) return; + var message = cachedMessage.Value; + Console.WriteLine($"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):" + + Environment.NewLine + + message.Content); + return Task.CompletedTask; + } + + #endregion +} \ No newline at end of file diff --git a/samples/seed/dotnet/project/Project/Class1.cs b/samples/seed/dotnet/project/Project/Class1.cs index 33242d42fd6..0c4b56a15fe 100644 --- a/samples/seed/dotnet/project/Project/Class1.cs +++ b/samples/seed/dotnet/project/Project/Class1.cs @@ -2,6 +2,8 @@ public class Class1 { + public class Test { } + /// /// This method should do something... /// @@ -38,5 +40,38 @@ public void Issue1651() { } /// public void Issue7484() { } - public class Test { } -} \ No newline at end of file + /// + /// + /// void Update() + /// { + /// myClass.Execute(); + /// } + /// + /// + /// + /// + /// + public void Issue4017() { } + + /// + /// For example: + /// + /// MyClass myClass = new MyClass(); + /// + /// void Update() + /// { + /// myClass.Execute(); + /// } + /// + /// + /// ```csharp + /// MyClass myClass = new MyClass(); + /// + /// void Update() + /// { + /// myClass.Execute(); + /// } + /// ``` + /// + public void Issue2623() { } +} diff --git a/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlComment.cs b/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlComment.cs index f67879d07a7..e75773cfda4 100644 --- a/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlComment.cs +++ b/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlComment.cs @@ -19,8 +19,6 @@ internal class XmlComment { private const string idSelector = @"((?![0-9])[\w_])+[\w\(\)\.\{\}\[\]\|\*\^~#@!`,_<>:]*"; private static readonly Regex CommentIdRegex = new(@"^(?N|T|M|P|F|E|Overload):(?" + idSelector + ")$", RegexOptions.Compiled); - private static readonly Regex LineBreakRegex = new(@"\r?\n", RegexOptions.Compiled); - private static readonly Regex CodeElementRegex = new(@"]*>([\s\S]*?)", RegexOptions.Compiled); private static readonly Regex RegionRegex = new(@"^\s*#region\s*(.*)$"); private static readonly Regex XmlRegionRegex = new(@"^\s*$"); private static readonly Regex EndRegionRegex = new(@"^\s*#endregion\s*.*$"); @@ -75,7 +73,8 @@ private XmlComment(string xml, XmlCommentParserContext context) ResolveCrefLink(doc, "//see[@cref]", context.AddReferenceDelegate); ResolveCrefLink(doc, "//exception[@cref]", context.AddReferenceDelegate); - ResolveCodeSource(doc, context); + ResolveCode(doc, context); + var nav = doc.CreateNavigator(); Summary = GetSingleNodeValue(nav, "/member/summary"); Remarks = GetSingleNodeValue(nav, "/member/remarks"); @@ -126,58 +125,47 @@ public string GetTypeParameter(string name) return TypeParameters.TryGetValue(name, out var value) ? value : null; } - private void ResolveCodeSource(XDocument doc, XmlCommentParserContext context) + private void ResolveCode(XDocument doc, XmlCommentParserContext context) { - foreach (XElement node in doc.XPathSelectElements("//code")) + foreach (var node in doc.XPathSelectElements("//code").ToList()) { - var source = node.Attribute("source"); - if (source == null || string.IsNullOrEmpty(source.Value)) + if (node.Attribute("data-inline") is { } inlineAttribute) { + inlineAttribute.Remove(); continue; } - var region = node.Attribute("region"); - - var path = source.Value; - if (!Path.IsPathRooted(path)) - { - string basePath; - - if (!string.IsNullOrEmpty(context.CodeSourceBasePath)) - { - basePath = context.CodeSourceBasePath; - } - else - { - if (context.Source == null || string.IsNullOrEmpty(context.Source.Path)) - { - Logger.LogWarning($"Unable to get source file path for {node.ToString()}"); - continue; - } - - basePath = Path.GetDirectoryName(Path.Combine(EnvironmentContext.BaseDirectory, context.Source.Path)); - } - - path = Path.Combine(basePath, path); - } - - ResolveCodeSource(node, path, region?.Value); + var indent = ((IXmlLineInfo)node).LinePosition - 2; + var (lang, value) = ResolveCodeSource(node, context); + value = TrimEachLine(value ?? node.Value, new(' ', indent)); + var code = new XElement("code", value); + code.SetAttributeValue("class", $"lang-{lang ?? "csharp"}"); + node.ReplaceWith(new XElement("pre", code)); } } - private void ResolveCodeSource(XElement element, string source, string region) + private (string lang, string code) ResolveCodeSource(XElement node, XmlCommentParserContext context) { - if (!File.Exists(source)) - { - Logger.LogWarning($"Source file '{source}' not found."); - return; - } + var source = node.Attribute("source")?.Value; + if (string.IsNullOrEmpty(source)) + return default; + + var lang = Path.GetExtension(source).TrimStart('.').ToLowerInvariant(); + + var code = context.ResolveCode?.Invoke(source); + if (code is null) + return (lang, null); + + var region = node.Attribute("region")?.Value; + if (region is null) + return (lang, code); var (regionRegex, endRegionRegex) = GetRegionRegex(source); var builder = new StringBuilder(); var regionCount = 0; - foreach (var line in File.ReadLines(source)) + + foreach (var line in ReadLines(code)) { if (!string.IsNullOrEmpty(region)) { @@ -215,7 +203,17 @@ private void ResolveCodeSource(XElement element, string source, string region) } } - element.SetValue(builder.ToString()); + return (lang, builder.ToString()); + } + + private static IEnumerable ReadLines(string text) + { + string line; + using var sr = new StringReader(text); + while ((line = sr.ReadLine()) != null) + { + yield return line; + } } private Dictionary GetListContent(XPathNavigator navigator, string xpath, string contentType, XmlCommentParserContext context) @@ -276,7 +274,9 @@ private void ResolveLangword(XNode node) } else { - item.ReplaceWith(new XElement("c", langword)); + var code = new XElement("code", langword); + code.SetAttributeValue("data-inline", "true"); + item.ReplaceWith(code); } } } @@ -484,103 +484,55 @@ private string GetXmlValue(XPathNavigator node) if (node is null) return null; - // NOTE: use node.InnerXml instead of node.Value, to keep decorative nodes, - // e.g. - // Value - // decode InnerXml as it encodes - // IXmlLineInfo.LinePosition starts from 1 and it would ignore '<' - // e.g. - // the LinePosition is the column number of 's', so it should be minus 2 - var lineInfo = node as IXmlLineInfo; - int column = lineInfo.HasLineInfo() ? lineInfo.LinePosition - 2 : 0; - - return NormalizeXml(RemoveLeadingSpaces(GetInnerXml(node)), column); + return TrimEachLine(GetInnerXml(node)); } - /// - /// Remove least common whitespces in each line of xml - /// - /// - /// xml after removing least common whitespaces - private static string RemoveLeadingSpaces(string xml) + private static string TrimEachLine(string text, string indent = "") { - var lines = LineBreakRegex.Split(xml); - var normalized = new List(); + var minLeadingWhitespace = int.MaxValue; + var lines = ReadLines(text).ToList(); + foreach (var line in lines) + { + if (string.IsNullOrWhiteSpace(line)) + continue; - var preIndex = 0; - var leadingSpaces = from line in lines - where !string.IsNullOrWhiteSpace(line) - select line.TakeWhile(char.IsWhiteSpace).Count(); + var leadingWhitespace = 0; + while (leadingWhitespace < line.Length && char.IsWhiteSpace(line[leadingWhitespace])) + leadingWhitespace++; - if (leadingSpaces.Any()) - { - preIndex = leadingSpaces.Min(); + minLeadingWhitespace = Math.Min(minLeadingWhitespace, leadingWhitespace); } - if (preIndex == 0) - { - return xml; - } + var builder = new StringBuilder(); - foreach (var line in lines) - { - if (string.IsNullOrWhiteSpace(line)) - { - normalized.Add(string.Empty); - } - else - { - normalized.Add(line.Substring(preIndex)); - } - } - return string.Join("\n", normalized); - } + // Trim leading empty lines + var trimStart = true; - /// - /// Split xml into lines. Trim meaningless whitespaces. - /// if a line starts with xml node, all leading whitespaces would be trimmed - /// otherwise text node start position always aligns with the start position of its parent line(the last previous line that starts with xml node) - /// Trim newline character for code element. - /// - /// - /// the start position of the last previous line that starts with xml node - /// normalized xml - private static string NormalizeXml(string xml, int parentIndex) - { - var lines = LineBreakRegex.Split(xml); - var normalized = new List(); + // Apply indentation to all lines except the first, + // since the first new line in
 is significant
+        var firstLine = true;
 
         foreach (var line in lines)
         {
+            if (trimStart && string.IsNullOrWhiteSpace(line))
+                continue;
+
+            if (firstLine)
+                firstLine = false;
+            else
+                builder.Append(indent);
+
             if (string.IsNullOrWhiteSpace(line))
             {
-                normalized.Add(string.Empty);
+                builder.AppendLine();
+                continue;
             }
-            else
-            {
-                // TO-DO: special logic for TAB case
-                int index = line.TakeWhile(char.IsWhiteSpace).Count();
-                if (line[index] == '<')
-                {
-                    parentIndex = index;
-                }
 
-                normalized.Add(line.Substring(Math.Min(parentIndex, index)));
-            }
+            trimStart = false;
+            builder.AppendLine(line.Substring(minLeadingWhitespace));
         }
 
-        // trim newline character for code element
-        return CodeElementRegex.Replace(
-            string.Join("\n", normalized),
-            m =>
-            {
-                var group = m.Groups[1];
-                if (group.Length == 0)
-                {
-                    return m.Value;
-                }
-                return m.Value.Replace(group.ToString(), group.ToString().Trim('\n'));
-            });
+        return builder.ToString().TrimEnd();
     }
 
     /// 
diff --git a/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentParserContext.cs b/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentParserContext.cs
index 4b1f47c8946..7457bea0710 100644
--- a/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentParserContext.cs
+++ b/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentParserContext.cs
@@ -7,9 +7,9 @@ namespace Microsoft.DocAsCode.Dotnet;
 
 internal class XmlCommentParserContext
 {
-    public Action AddReferenceDelegate { get; set; }
+    public Action AddReferenceDelegate { get; init; }
 
-    public SourceDetail Source { get; set; }
+    public Func ResolveCode { get; init; }
 
-    public string CodeSourceBasePath { get; set; }
+    public SourceDetail Source { get; init; }
 }
diff --git a/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentTransformer.cs b/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentTransformer.cs
index 6242d85d79b..d564a0f1474 100644
--- a/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentTransformer.cs
+++ b/src/Microsoft.DocAsCode.Dotnet/Parsers/XmlCommentTransformer.cs
@@ -30,9 +30,7 @@ public static XDocument Transform(string xml)
         using var ms = new MemoryStream();
         using var writer = new XHtmlWriter(new StreamWriter(ms));
         XDocument doc = XDocument.Parse(xml, LoadOptions.PreserveWhitespace);
-        var args = new XsltArgumentList();
-        args.AddParam("language", "urn:input-variables", "csharp");
-        _transform.Transform(doc.CreateNavigator(), args, writer);
+        _transform.Transform(doc.CreateNavigator(), writer);
         ms.Seek(0, SeekOrigin.Begin);
         return XDocument.Load(ms, LoadOptions.PreserveWhitespace | LoadOptions.SetLineInfo);
     }
diff --git a/src/Microsoft.DocAsCode.Dotnet/Resources/XmlCommentTransform.xsl b/src/Microsoft.DocAsCode.Dotnet/Resources/XmlCommentTransform.xsl
index 1746e334fbd..236d49c7383 100644
--- a/src/Microsoft.DocAsCode.Dotnet/Resources/XmlCommentTransform.xsl
+++ b/src/Microsoft.DocAsCode.Dotnet/Resources/XmlCommentTransform.xsl
@@ -7,50 +7,18 @@
 
   
 
-  
-
   
     

- - - - - - - - - - - - - - - - - - - + - - - - - lang- - - - - - - - @@ -77,7 +45,7 @@ - + @@ -85,14 +53,14 @@ - + - + diff --git a/src/Microsoft.DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs b/src/Microsoft.DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs index ced661b5f31..2d8226355c0 100644 --- a/src/Microsoft.DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs +++ b/src/Microsoft.DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs @@ -7,8 +7,10 @@ using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Shared.Extensions; +using Microsoft.DocAsCode.Common; using Microsoft.DocAsCode.DataContracts.ManagedReference; using Microsoft.DocAsCode.Exceptions; +using Microsoft.DocAsCode.Plugins; namespace Microsoft.DocAsCode.Dotnet; @@ -726,10 +728,39 @@ private XmlCommentParserContext GetXmlCommentParserContext(MetadataItem item) { return new XmlCommentParserContext { - AddReferenceDelegate = GetAddReferenceDelegate(item), + AddReferenceDelegate = AddReferenceDelegate, Source = item.Source, - CodeSourceBasePath = _codeSourceBasePath + ResolveCode = ResolveCode, }; + + void AddReferenceDelegate(string id, string commentId) + { + var r = AddReference(id, commentId); + if (item.References == null) + { + item.References = new Dictionary(); + } + + // only record the id now, the value would be fed at later phase after merge + item.References[id] = null; + } + + string ResolveCode(string source) + { + var basePath = _codeSourceBasePath ?? ( + item.Source?.Path is {} sourcePath + ? Path.GetDirectoryName(Path.GetFullPath(Path.Combine(EnvironmentContext.BaseDirectory, sourcePath))) + : null); + + var path = Path.GetFullPath(Path.Combine(basePath, source)); + if (!File.Exists(path)) + { + Logger.LogWarning($"Source file '{path}' not found."); + return null; + } + + return File.ReadAllText(path); + } } private List GetAttributeInfo(ImmutableArray attributes) @@ -856,19 +887,4 @@ private NamedArgumentInfo GetNamedArgumentInfo(KeyValuePair GetAddReferenceDelegate(MetadataItem item) - { - return (id, commentId) => - { - var r = AddReference(id, commentId); - if (item.References == null) - { - item.References = new Dictionary(); - } - - // only record the id now, the value would be fed at later phase after merge - item.References[id] = null; - }; - } } diff --git a/test/Microsoft.DocAsCode.Dotnet.Tests/GenerateMetadataFromCSUnitTest.cs b/test/Microsoft.DocAsCode.Dotnet.Tests/GenerateMetadataFromCSUnitTest.cs index 148d9ce307b..55330174fb0 100644 --- a/test/Microsoft.DocAsCode.Dotnet.Tests/GenerateMetadataFromCSUnitTest.cs +++ b/test/Microsoft.DocAsCode.Dotnet.Tests/GenerateMetadataFromCSUnitTest.cs @@ -55,9 +55,7 @@ public void Func1(int i) Assert.Equal("Class1", @class.DisplayNames.First().Value); Assert.Equal("Class1", @class.DisplayNamesWithType.First().Value); Assert.Equal("Test1.Class1", @class.DisplayQualifiedNames.First().Value); - Assert.Equal(@" -This is a test -".Replace("\r\n", "\n"), @class.Summary); + Assert.Equal("This is a test", @class.Summary); Assert.Equal("Test1.Class1.Func1(System.Int32)", @class.SeeAlsos[0].LinkId); Assert.Equal(@"[Serializable] public class Class1", @class.Syntax.Content[SyntaxLanguage.CSharp]); @@ -68,9 +66,7 @@ public class Class1", @class.Syntax.Content[SyntaxLanguage.CSharp]); Assert.Equal("Class1.Func1(int)", function.DisplayNamesWithType.First().Value); Assert.Equal("Test1.Class1.Func1(int)", function.DisplayQualifiedNames.First().Value); Assert.Equal("Test1.Class1.Func1(System.Int32)", function.Name); - Assert.Equal(@" -This is a function -".Replace("\r\n", "\n"), function.Summary); + Assert.Equal("This is a function", function.Summary); Assert.Equal("System.Int32", function.SeeAlsos[0].LinkId); Assert.Equal("This is a param as ", function.Syntax.Parameters[0].Description); Assert.Single(output.Items); diff --git a/test/Microsoft.DocAsCode.Dotnet.Tests/XmlCommentUnitTest.cs b/test/Microsoft.DocAsCode.Dotnet.Tests/XmlCommentUnitTest.cs index 5a97b268ee2..cbc89f40c9f 100644 --- a/test/Microsoft.DocAsCode.Dotnet.Tests/XmlCommentUnitTest.cs +++ b/test/Microsoft.DocAsCode.Dotnet.Tests/XmlCommentUnitTest.cs @@ -24,7 +24,7 @@ private static void Verify(string comment, string summary) public static void SeeLangword() { Verify("", "if"); - Verify("", "undefined-langword"); + Verify("", "undefined-langword"); } [Fact] @@ -46,12 +46,35 @@ public static void Issue4165() } [Fact] - public void TestXmlCommentParser() + public static void BasicCodeBlock() { - string inputFolder = Path.GetRandomFileName(); - Directory.CreateDirectory(inputFolder); - File.WriteAllText(Path.Combine(inputFolder, "Example.cs"), """ + var comment = XmlComment.Parse( + """ + + + public int Main(string[] args) + { + Console.HelloWorld(); + } + + + """); + + Assert.Equal( + """ +
public int Main(string[] args)
+            {
+                Console.HelloWorld();
+            }
+ """, + comment.Remarks, + ignoreLineEndingDifferences: true); + } + [Fact] + public static void ExternalCodeBlockCSharp() + { + var example = """ using System; namespace Example @@ -66,10 +89,109 @@ public int Main(string[] args) } #endregion } + """; + + var comment = XmlComment.Parse( + """ + + + + """, + new() { ResolveCode = _ => example }); + + Assert.Equal( + """ +
static class Program
+            {
+                public int Main(string[] args)
+                {
+                    Console.HelloWorld();
+                }
+            }
+ """, + comment.Remarks, + ignoreLineEndingDifferences: true); + } + + [Fact] + public void ExternalCodeBlockXaml() + { + var example = """ + + + + + + + + + """; + + var input = """ + + + This is an example using source reference in a xaml file. + + + + """; + + var commentModel = XmlComment.Parse(input, new() { ResolveCode = _ => example }); + + Assert.Equal( + """ + This is an example using source reference in a xaml file. +
<Grid>
+              <TextBlock Text="Hello World" />
+            </Grid>
+ """, + commentModel.Examples.Single(), + ignoreLineEndingDifferences: true); + } + + [Fact] + public static void MarkdownCodeBlock() + { + var comment = XmlComment.Parse( + """ + + public int Main(string[] args) + { + Console.HelloWorld(); + } + + + For example: + + public int Main(string[] args) + { + Console.HelloWorld(); + } + """); - string input = """ + Assert.Equal(""" + public int Main(string[] args) + { + Console.HelloWorld(); + } + """, comment.Summary, ignoreLineEndingDifferences: true); + + Assert.Equal(""" + For example: + + public int Main(string[] args) + { + Console.HelloWorld(); + } + """, comment.Remarks, ignoreLineEndingDifferences: true); + } + + [Fact] + public void TestXmlCommentParser() + { + var input = """ Partial classes can not cross assemblies, Test @@ -155,26 +277,16 @@ Check empty code. """; - var context = new XmlCommentParserContext - { - AddReferenceDelegate = null, - Source = new SourceDetail - { - Path = Path.Combine(inputFolder, "Source.cs"), - } - }; - var commentModel = XmlComment.Parse(input, context); + var commentModel = XmlComment.Parse(input); var summary = commentModel.Summary; Assert.Equal(""" - Partial classes can not cross assemblies, Test null ``` Classes in assemblies are by definition complete. ``` - """, summary, ignoreLineEndingDifferences: true); var returns = commentModel.Returns; @@ -185,21 +297,19 @@ Classes in assemblies are by definition complete. var remarks = commentModel.Remarks; Assert.Equal(""" - https://example.org example -

This is ref a sample of exception node

+

This is ref a sample of exception node

  • -
    public class XmlElement
    -                : XmlLinkedNode
    -
    1. - word inside list->listItem->list->listItem->para.> - the second line. -
    2. item2 in numbered list
    -
  • item2 in bullet list
  • - loose text not wrapped in description -
- +
public class XmlElement
+                            : XmlLinkedNode
+
  1. + word inside list->listItem->list->listItem->para.> + the second line. +
  2. item2 in numbered list
+
  • item2 in bullet list
  • + loose text not wrapped in description +
  • """, remarks, ignoreLineEndingDifferences: true); var exceptions = commentModel.Exceptions; @@ -211,46 +321,32 @@ loose text not wrapped in description commentModel.Examples, e => Assert.Equal( """ - This sample shows how to call the method. -
    class TestClass
    -                {
    -                    static int Main()
    -                    {
    -                        return GetExceptions(null, null).Count();
    -                    }
    -                } 
    - +
    class TestClass
    +                 {
    +                     static int Main()
    +                     {
    +                         return GetExceptions(null, null).Count();
    +                     }
    +                 }
    """, e, ignoreLineEndingDifferences: true), e => Assert.Equal( """ - This is another example - """, e, ignoreLineEndingDifferences: true), e => Assert.Equal( """ - Check empty code. -
    - +
    """, e, ignoreLineEndingDifferences: true), e => Assert.Equal( """ - This is an example using source reference. -
        static class Program
    -                {
    -                    public int Main(string[] args)
    -                    {
    -                        Console.HelloWorld();
    -                    }
    -                }
    - +
    """, e, ignoreLineEndingDifferences: true) ); - commentModel = XmlComment.Parse(input, context); + commentModel = XmlComment.Parse(input); var seeAlsos = commentModel.SeeAlsos; Assert.Equal(3, seeAlsos.Count); @@ -265,8 +361,6 @@ public int Main(string[] args) [Fact] public void SeeAltText() { - string inputFolder = Path.GetRandomFileName(); - Directory.CreateDirectory(inputFolder); string input = """ @@ -281,22 +375,12 @@ public void SeeAltText() This is an Exception. """; - var context = new XmlCommentParserContext - { - AddReferenceDelegate = null, - Source = new SourceDetail - { - Path = Path.Combine(inputFolder, "Source.cs"), - } - }; - var commentModel = XmlComment.Parse(input, context); + var commentModel = XmlComment.Parse(input); var summary = commentModel.Summary; Assert.Equal(""" - Class summary - """, summary, ignoreLineEndingDifferences: true); var returns = commentModel.Returns; @@ -307,70 +391,10 @@ public void SeeAltText() var remarks = commentModel.Remarks; Assert.Equal(""" - See . - """, remarks, ignoreLineEndingDifferences: true); } - [Fact] - public void TestXmlCommentParserForXamlSource() - { - string inputFolder = Path.GetRandomFileName(); - Directory.CreateDirectory(inputFolder); - var expectedExampleContent = """ - - - - """; - - File.WriteAllText(Path.Combine(inputFolder, "Example.xaml"), $@" - - - - -{expectedExampleContent} - -"); - string input = """ - - - - - Something - - - This is an example using source reference in a xaml file. - - - - """; - var context = new XmlCommentParserContext - { - AddReferenceDelegate = null, - Source = new SourceDetail - { - Path = Path.Combine(inputFolder, "Source.cs"), - } - }; - - var commentModel = XmlComment.Parse(input, context); - - // using xml to get rid of escaped tags - var example = commentModel.Examples.Single(); - var doc = XDocument.Parse($"{example}"); - var codeNode = doc.Descendants("code").Single(); - var actual = NormalizeWhitespace(codeNode.Value); - var expected = NormalizeWhitespace(expectedExampleContent); - Assert.Equal(expected, actual, ignoreLineEndingDifferences: true); - } - [Fact] public void ParseXmlCommentWithoutRootNode() { @@ -378,13 +402,4 @@ public void ParseXmlCommentWithoutRootNode() var commentModel = XmlComment.Parse(input, new XmlCommentParserContext()); Assert.Equal("A", commentModel.Summary); } - - /// - /// Normalizes multiple whitespaces into 1 single whitespace to allow ignoring of insignificant whitespaces. - /// - private string NormalizeWhitespace(string s) - { - var regex = new Regex(@"(?<= ) +"); - return regex.Replace(s, string.Empty); - } } diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp10.Issue7737.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp10.Issue7737.html.view.verified.json index 4464ed8acaa..fd296e5f673 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp10.Issue7737.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp10.Issue7737.html.view.verified.json @@ -175,7 +175,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    \n", + "summary": "

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_Issue7737_Foo.md&value=---%0Auid%3A%20CSharp10.Issue7737.Foo%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L33", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.Issue4007.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.Issue4007.html.view.verified.json index c41032e1d4e..e9ec2796be5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.Issue4007.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.Issue4007.html.view.verified.json @@ -467,7 +467,7 @@ ], "level": 0.0 }, - "summary": "

    This works: .\nThis does not work: .

    \n", + "summary": "

    This works: .\nThis does not work: .

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.html.view.verified.json index 27c4dfb8e81..78bca6579f9 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.CSharp/api/CSharp8.html.view.verified.json @@ -112,7 +112,7 @@ } ], "level": 0.0, - "summary": "

    This works: .\nThis does not work: .

    \n", + "summary": "

    This works: .\nThis does not work: .

    \n", "type": "class", "platform": null, "isEii": false, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.Class1.html.view.verified.json index 7fd4481060e..a2df922ea91 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.Class1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.Class1.html.view.verified.json @@ -410,7 +410,7 @@ ], "level": 0.0 }, - "summary": "

    This is a test class.

    \n", + "summary": "

    This is a test class.

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.html.view.verified.json index e3649d9342b..3b3038fb900 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.html.view.verified.json @@ -54,7 +54,7 @@ } ], "level": 0.0, - "summary": "

    This is a test class.

    \n", + "summary": "

    This is a test class.

    \n", "type": "class", "platform": null, "isEii": false, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Class1.Test-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Class1.Test-1.html.view.verified.json index da7a094be43..ed2eec16147 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Class1.Test-1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Class1.Test-1.html.view.verified.json @@ -92,7 +92,7 @@ }, "id": "Test", "path": "dotnet/project/Project/Class1.cs", - "startLine": 40.0, + "startLine": 4.0, "endLine": 0.0, "isExternal": false }, @@ -575,7 +575,7 @@ "_tocRel": "toc.html", "yamlmime": "ManagedReference", "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Class1_Test_1.md&value=---%0Auid%3A%20BuildFromProject.Class1.Test%601%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L41", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L5", "summary": "", "remarks": "", "conceptual": "", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Class1.html.view.verified.json index 8a38cd6c80b..a546bbe900f 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Class1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Class1.html.view.verified.json @@ -120,7 +120,7 @@ }, "id": "Issue1651", "path": "dotnet/project/Project/Class1.cs", - "startLine": 28.0, + "startLine": 30.0, "endLine": 0.0, "isExternal": false }, @@ -175,10 +175,10 @@ }, "level": 0.0, "type": "method", - "summary": "

    Pricing models are used to calculate theoretical option values

    \n
    • 1Black Scholes
    • 2Black76
    • 3Black76Fut
    • 4Equity Tree
    • 5Variance Swap
    • 6Dividend Forecast
    \n", + "summary": "

    Pricing models are used to calculate theoretical option values

    \n
    • 1Black Scholes
    • 2Black76
    • 3Black76Fut
    • 4Equity Tree
    • 5Variance Swap
    • 6Dividend Forecast
    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Class1_Issue1651.md&value=---%0Auid%3A%20BuildFromProject.Class1.Issue1651%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L29", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L31", "remarks": "", "conceptual": "", "implements": "", @@ -187,6 +187,276 @@ "hideTitleType": false, "hideSubtitle": false }, + { + "uid": "BuildFromProject.Class1.Issue2623", + "isEii": false, + "isExtensionMethod": false, + "parent": "BuildFromProject.Class1", + "isExternal": false, + "name": [ + { + "lang": "csharp", + "value": "Issue2623()" + }, + { + "lang": "vb", + "value": "Issue2623()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Class1.Issue2623()" + }, + { + "lang": "vb", + "value": "Class1.Issue2623()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Class1.Issue2623()" + }, + { + "lang": "vb", + "value": "BuildFromProject.Class1.Issue2623()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "syntax": { + "content": [ + { + "lang": "csharp", + "value": "public void Issue2623()" + }, + { + "lang": "vb", + "value": "Public Sub Issue2623()" + } + ] + }, + "source": { + "remote": { + "path": "samples/seed/dotnet/project/Project/Class1.cs", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "id": "Issue2623", + "path": "dotnet/project/Project/Class1.cs", + "startLine": 75.0, + "endLine": 0.0, + "isExternal": false + }, + "assemblies": [ + "BuildFromProject" + ], + "namespace": "BuildFromProject", + "remarks": "

    For example:

    \n
    MyClass myClass = new MyClass();\n\nvoid Update()\n{\n    myClass.Execute();\n}\n
    \n", + "example": [ + "
    MyClass myClass = new MyClass();\n\nvoid Update()\n{\n    myClass.Execute();\n}\n
    \n" + ], + "overload": { + "uid": "BuildFromProject.Class1.Issue2623*", + "name": [ + { + "lang": "csharp", + "value": "Issue2623" + }, + { + "lang": "vb", + "value": "Issue2623" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Class1.Issue2623" + }, + { + "lang": "vb", + "value": "Class1.Issue2623" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Class1.Issue2623" + }, + { + "lang": "vb", + "value": "BuildFromProject.Class1.Issue2623" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "id": "BuildFromProject_Class1_Issue2623_" + }, + "level": 0.0, + "type": "method", + "summary": "", + "platform": null, + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Class1_Issue2623.md&value=---%0Auid%3A%20BuildFromProject.Class1.Issue2623%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L76", + "conceptual": "", + "implements": "", + "seealso": null, + "id": "BuildFromProject_Class1_Issue2623", + "hideTitleType": false, + "hideSubtitle": false + }, + { + "uid": "BuildFromProject.Class1.Issue4017", + "isEii": false, + "isExtensionMethod": false, + "parent": "BuildFromProject.Class1", + "isExternal": false, + "name": [ + { + "lang": "csharp", + "value": "Issue4017()" + }, + { + "lang": "vb", + "value": "Issue4017()" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Class1.Issue4017()" + }, + { + "lang": "vb", + "value": "Class1.Issue4017()" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Class1.Issue4017()" + }, + { + "lang": "vb", + "value": "BuildFromProject.Class1.Issue4017()" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "syntax": { + "content": [ + { + "lang": "csharp", + "value": "public void Issue4017()" + }, + { + "lang": "vb", + "value": "Public Sub Issue4017()" + } + ] + }, + "source": { + "remote": { + "path": "samples/seed/dotnet/project/Project/Class1.cs", + "branch": "main", + "repo": "https://github.com/dotnet/docfx" + }, + "id": "Issue4017", + "path": "dotnet/project/Project/Class1.cs", + "startLine": 53.0, + "endLine": 0.0, + "isExternal": false + }, + "assemblies": [ + "BuildFromProject" + ], + "namespace": "BuildFromProject", + "remarks": "
    void Update()\n{\n    myClass.Execute();\n}
    \n", + "example": [ + "
    public void HookMessageDeleted(BaseSocketClient client)\n{\n    client.MessageDeleted += HandleMessageDelete;\n}\n\npublic Task HandleMessageDelete(Cacheable<IMessage, ulong> cachedMessage, ISocketMessageChannel channel)\n{\n    // check if the message exists in cache; if not, we cannot report what was removed\n    if (!cachedMessage.HasValue) return;\n    var message = cachedMessage.Value;\n    Console.WriteLine($"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):"\n        + Environment.NewLine\n        + message.Content);\n    return Task.CompletedTask;\n}
    \n" + ], + "overload": { + "uid": "BuildFromProject.Class1.Issue4017*", + "name": [ + { + "lang": "csharp", + "value": "Issue4017" + }, + { + "lang": "vb", + "value": "Issue4017" + } + ], + "nameWithType": [ + { + "lang": "csharp", + "value": "Class1.Issue4017" + }, + { + "lang": "vb", + "value": "Class1.Issue4017" + } + ], + "fullName": [ + { + "lang": "csharp", + "value": "BuildFromProject.Class1.Issue4017" + }, + { + "lang": "vb", + "value": "BuildFromProject.Class1.Issue4017" + } + ], + "specName": [ + { + "lang": "csharp", + "value": "" + }, + { + "lang": "vb", + "value": "" + } + ], + "id": "BuildFromProject_Class1_Issue4017_" + }, + "level": 0.0, + "type": "method", + "summary": "", + "platform": null, + "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Class1_Issue4017.md&value=---%0Auid%3A%20BuildFromProject.Class1.Issue4017%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L54", + "conceptual": "", + "implements": "", + "seealso": null, + "id": "BuildFromProject_Class1_Issue4017", + "hideTitleType": false, + "hideSubtitle": false + }, { "uid": "BuildFromProject.Class1.Issue7484", "isEii": false, @@ -253,7 +523,7 @@ }, "id": "Issue7484", "path": "dotnet/project/Project/Class1.cs", - "startLine": 38.0, + "startLine": 40.0, "endLine": 0.0, "isExternal": false }, @@ -261,7 +531,7 @@ "BuildFromProject" ], "namespace": "BuildFromProject", - "remarks": "

    There's really no reason to not believe that this class can test things.

    \n
    TermDescription
    A TermA Description
    Bee TermBee Description
    \n", + "remarks": "

    There's really no reason to not believe that this class can test things.

    \n
    TermDescription
    A TermA Description
    Bee TermBee Description
    \n", "example": [], "overload": { "uid": "BuildFromProject.Class1.Issue7484*", @@ -312,7 +582,7 @@ "summary": "", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Class1_Issue7484.md&value=---%0Auid%3A%20BuildFromProject.Class1.Issue7484%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L39", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L41", "conceptual": "", "implements": "", "seealso": null, @@ -386,7 +656,7 @@ }, "id": "Issue896", "path": "dotnet/project/Project/Class1.cs", - "startLine": 15.0, + "startLine": 17.0, "endLine": 0.0, "isExternal": false }, @@ -490,10 +760,10 @@ ], "level": 0.0, "type": "method", - "summary": "

    Test

    \n", + "summary": "

    Test

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Class1_Issue896.md&value=---%0Auid%3A%20BuildFromProject.Class1.Issue896%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L16", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L18", "remarks": "", "conceptual": "", "implements": "", @@ -567,7 +837,7 @@ }, "id": "XmlCommentIncludeTag", "path": "dotnet/project/Project/Class1.cs", - "startLine": 8.0, + "startLine": 10.0, "endLine": 0.0, "isExternal": false }, @@ -575,7 +845,7 @@ "BuildFromProject" ], "namespace": "BuildFromProject", - "remarks": "

    This is remarks.

    \n", + "remarks": "

    This is remarks.

    \n", "example": [], "overload": { "uid": "BuildFromProject.Class1.XmlCommentIncludeTag*", @@ -623,10 +893,10 @@ }, "level": 0.0, "type": "method", - "summary": "

    This method should do something...

    \n", + "summary": "

    This method should do something...

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Class1_XmlCommentIncludeTag.md&value=---%0Auid%3A%20BuildFromProject.Class1.XmlCommentIncludeTag%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", - "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L9", + "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Class1.cs/#L11", "conceptual": "", "implements": "", "seealso": null, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.IInheritdoc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.IInheritdoc.html.view.verified.json index ffed0755baa..378864178f3 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.IInheritdoc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.IInheritdoc.html.view.verified.json @@ -175,7 +175,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    This method should do something...

    \n", + "summary": "

    This method should do something...

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_IInheritdoc_Issue7629.md&value=---%0Auid%3A%20BuildFromProject.IInheritdoc.Issue7629%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L8", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json index c47ed417534..2c7df9cd26d 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue6366.Class1-1.html.view.verified.json @@ -319,7 +319,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    This text inherited.

    \n", + "summary": "

    This text inherited.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue6366_Class1_1_TestMethod1__0_System_Int32_.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue6366.Class1%601.TestMethod1(%600%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L102", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json index e2270e8ced8..7171658721b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue6366.Class2.html.view.verified.json @@ -361,7 +361,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    This text inherited.

    \n", + "summary": "

    This text inherited.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue6366_Class2_TestMethod1_System_Boolean_System_Int32_.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue6366.Class2.TestMethod1(System.Boolean%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L108", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json index 3aa8ed00b5c..65c643c8515 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue7484.html.view.verified.json @@ -175,7 +175,7 @@ }, "level": 0.0, "type": "constructor", - "summary": "

    This is a constructor to document.

    \n", + "summary": "

    This is a constructor to document.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue7484__ctor.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue7484.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L64", @@ -362,7 +362,7 @@ }, "level": 0.0, "type": "property", - "summary": "

    A string that could have something.

    \n", + "summary": "

    A string that could have something.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue7484_DoDad.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue7484.DoDad%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L69", @@ -550,7 +550,7 @@ "BuildFromProject" ], "namespace": "BuildFromProject", - "remarks": "

    I'd like to take a moment to thank all of those who helped me get to\na place where I can write documentation like this.

    \n", + "remarks": "

    I'd like to take a moment to thank all of those who helped me get to\na place where I can write documentation like this.

    \n", "example": [], "overload": { "uid": "BuildFromProject.Inheritdoc.Issue7484.BoolReturningMethod*", @@ -598,7 +598,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Simple method to generate docs for.

    \n", + "summary": "

    Simple method to generate docs for.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue7484_BoolReturningMethod_System_Boolean_.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue7484.BoolReturningMethod(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L80", @@ -708,8 +708,8 @@ ], "level": 0.0 }, - "summary": "

    This is a test class to have something for DocFX to document.

    \n", - "remarks": "

    We're going to talk about things now.

    \n
    \nSimple method to generate docs for.\n
    \nA string that could have something.\n
    \n", + "summary": "

    This is a test class to have something for DocFX to document.

    \n", + "remarks": "

    We're going to talk about things now.

    \n
    \nSimple method to generate docs for.\n
    \nA string that could have something.\n
    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json index 65135596ab1..4db44a468f9 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.Issue8101.html.view.verified.json @@ -412,7 +412,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Create a new tween.

    \n", + "summary": "

    Create a new tween.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue8101_Tween_System_Int32_System_Int32_System_Single_System_Action_System_Int32__.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue8101.Tween(System.Int32%2CSystem.Int32%2CSystem.Single%2CSystem.Action%7BSystem.Int32%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L33", @@ -782,7 +782,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Create a new tween.

    \n", + "summary": "

    Create a new tween.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue8101_Tween_System_Single_System_Single_System_Single_System_Action_System_Single__.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue8101.Tween(System.Single%2CSystem.Single%2CSystem.Single%2CSystem.Action%7BSystem.Single%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L30", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.html.view.verified.json index a882a24fe63..e1ac37daa7a 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.Inheritdoc.html.view.verified.json @@ -352,7 +352,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    This method should do something...

    \n", + "summary": "

    This method should do something...

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue7628.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue7628%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L18", @@ -530,7 +530,7 @@ } ], "type": "method", - "summary": "

    This method should do something...

    \n", + "summary": "

    This method should do something...

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromProject_Inheritdoc_Issue7629.md&value=---%0Auid%3A%20BuildFromProject.Inheritdoc.Issue7629%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/project/Project/Inheritdoc.cs/#L15", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json index c1cbc9cda77..4be1e2933a2 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromProject.html.view.verified.json @@ -472,7 +472,7 @@ } ], "level": 0.0, - "summary": "

    This is a test class to have something for DocFX to document.

    \n", + "summary": "

    This is a test class to have something for DocFX to document.

    \n", "type": "class", "platform": null, "isEii": false, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.BaseClass1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.BaseClass1.html.view.verified.json index 8795a17bc30..c6c35829987 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.BaseClass1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.BaseClass1.html.view.verified.json @@ -379,7 +379,7 @@ ], "level": 0.0 }, - "summary": "

    This is the BaseClass

    \n", + "summary": "

    This is the BaseClass

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.Class1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.Class1.html.view.verified.json index 5d70d65dcb3..aab4d78dda5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.Class1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.Class1.html.view.verified.json @@ -177,7 +177,7 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

    This is a Value type

    \n", + "summary": "

    This is a Value type

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromVBSourceCode_Class1_ValueClass.md&value=---%0Auid%3A%20BuildFromVBSourceCode.Class1.ValueClass%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/vb/Class1.vb/#L14", @@ -615,7 +615,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    This is a Function

    \n", + "summary": "

    This is a Function

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromVBSourceCode_Class1_Value_System_String_.md&value=---%0Auid%3A%20BuildFromVBSourceCode.Class1.Value(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/vb/Class1.vb/#L37", @@ -884,7 +884,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    What is Sub?

    \n", + "summary": "

    What is Sub?

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=BuildFromVBSourceCode_Class1_WithDeclarationKeyword_BuildFromVBSourceCode_Class1_.md&value=---%0Auid%3A%20BuildFromVBSourceCode.Class1.WithDeclarationKeyword(BuildFromVBSourceCode.Class1)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/vb/Class1.vb/#L26", @@ -995,7 +995,7 @@ ], "level": 0.0 }, - "summary": "

    This is summary from vb class...

    \n", + "summary": "

    This is summary from vb class...

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.html.view.verified.json index 8dd7a36be01..2af39b9cdb0 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.html.view.verified.json @@ -53,7 +53,7 @@ } ], "level": 0.0, - "summary": "

    This is the BaseClass

    \n", + "summary": "

    This is the BaseClass

    \n", "type": "class", "platform": null, "isEii": false, @@ -114,7 +114,7 @@ } ], "level": 0.0, - "summary": "

    This is summary from vb class...

    \n", + "summary": "

    This is summary from vb class...

    \n", "type": "class", "platform": null, "isEii": false, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Cat-2.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Cat-2.html.view.verified.json index 52ac3442656..b57f986b1c1 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Cat-2.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Cat-2.html.view.verified.json @@ -175,7 +175,7 @@ }, "level": 0.0, "type": "constructor", - "summary": "

    Default constructor.

    \n", + "summary": "

    Default constructor.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2__ctor.md&value=---%0Auid%3A%20CatLibrary.Cat%602.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L122", @@ -358,7 +358,7 @@ }, "level": 0.0, "type": "constructor", - "summary": "

    Constructor with one generic parameter.

    \n", + "summary": "

    Constructor with one generic parameter.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2__ctor__0_.md&value=---%0Auid%3A%20CatLibrary.Cat%602.%23ctor(%600)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L128", @@ -681,7 +681,7 @@ }, "level": 0.0, "type": "constructor", - "summary": "

    It's a complex constructor. The parameter will have some attributes.

    \n", + "summary": "

    It's a complex constructor. The parameter will have some attributes.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2__ctor_System_String_System_Int32__System_String_System_Boolean_.md&value=---%0Auid%3A%20CatLibrary.Cat%602.%23ctor(System.String%2CSystem.Int32%40%2CSystem.String%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L137", @@ -835,7 +835,7 @@ } ], "type": "field", - "summary": "

    Field with attribute.

    \n", + "summary": "

    Field with attribute.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_isHealthy.md&value=---%0Auid%3A%20CatLibrary.Cat%602.isHealthy%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L231", @@ -1022,7 +1022,7 @@ }, "level": 0.0, "type": "property", - "summary": "

    Hint cat's age.

    \n", + "summary": "

    Hint cat's age.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_Age.md&value=---%0Auid%3A%20CatLibrary.Cat%602.Age%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L213", @@ -1251,7 +1251,7 @@ }, "level": 0.0, "type": "property", - "summary": "

    This is index property of Cat. You can see that the visibility is different between get and set method.

    \n", + "summary": "

    This is index property of Cat. You can see that the visibility is different between get and set method.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_Item_System_String_.md&value=---%0Auid%3A%20CatLibrary.Cat%602.Item(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L204", @@ -1476,7 +1476,7 @@ } ], "type": "property", - "summary": "

    EII property.

    \n", + "summary": "

    EII property.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_Name.md&value=---%0Auid%3A%20CatLibrary.Cat%602.Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L255", @@ -2041,7 +2041,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Override the method of Object.Equals(object obj).

    \n", + "summary": "

    Override the method of Object.Equals(object obj).

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_Equals_System_Object_.md&value=---%0Auid%3A%20CatLibrary.Cat%602.Equals(System.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L165", @@ -2316,7 +2316,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    It's an unsafe method.\nAs you see, catName is a pointer, so we need to add unsafe keyword.

    \n", + "summary": "

    It's an unsafe method.\nAs you see, catName is a pointer, so we need to add unsafe keyword.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_GetTailLength_System_Int32__System_Object___.md&value=---%0Auid%3A%20CatLibrary.Cat%602.GetTailLength(System.Int32*%2CSystem.Object%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L174", @@ -2654,7 +2654,7 @@ } ], "type": "method", - "summary": "

    This method have attribute above it.

    \n", + "summary": "

    This method have attribute above it.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_Jump__0__1_System_Boolean__.md&value=---%0Auid%3A%20CatLibrary.Cat%602.Jump(%600%2C%601%2CSystem.Boolean%40)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L154", @@ -2796,7 +2796,7 @@ "example": [], "level": 0.0, "type": "event", - "summary": "

    Eat event of this cat

    \n", + "summary": "

    Eat event of this cat

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_ownEat.md&value=---%0Auid%3A%20CatLibrary.Cat%602.ownEat%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L223", @@ -3012,7 +3012,7 @@ } ] }, - "description": "

    Result with int type.

    \n" + "description": "

    Result with int type.

    \n" } }, "source": { @@ -3074,7 +3074,7 @@ }, "level": 0.0, "type": "operator", - "summary": "

    Addition operator of this class.

    \n", + "summary": "

    Addition operator of this class.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_op_Addition_CatLibrary_Cat__0__1__System_Int32_.md&value=---%0Auid%3A%20CatLibrary.Cat%602.op_Addition(CatLibrary.Cat%7B%600%2C%601%7D%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L183", @@ -3298,7 +3298,7 @@ }, "level": 0.0, "type": "operator", - "summary": "

    Expilicit operator of this class.

    \n

    It means this cat can evolve to change to Tom. Tom and Jerry.

    \n", + "summary": "

    Expilicit operator of this class.

    \n

    It means this cat can evolve to change to Tom. Tom and Jerry.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_op_Explicit_CatLibrary_Cat__0__1___CatLibrary_Tom.md&value=---%0Auid%3A%20CatLibrary.Cat%602.op_Explicit(CatLibrary.Cat%7B%600%2C%601%7D)~CatLibrary.Tom%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L196", @@ -3566,7 +3566,7 @@ }, "level": 0.0, "type": "operator", - "summary": "

    Similar with operaotr +, refer to that topic.

    \n", + "summary": "

    Similar with operaotr +, refer to that topic.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Cat_2_op_Subtraction_CatLibrary_Cat__0__1__System_Int32_.md&value=---%0Auid%3A%20CatLibrary.Cat%602.op_Subtraction(CatLibrary.Cat%7B%600%2C%601%7D%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L188", @@ -3688,10 +3688,10 @@ ], "level": 0.0 }, - "summary": "

    Here's main class of this Demo.

    \n

    You can see mostly type of article within this class and you for more detail, please see the remarks.

    \n

    \n

    this class is a template class. It has two Generic parameter. they are: T and K.

    \n

    The extension method of this class can refer to class

    \n", + "summary": "

    Here's main class of this Demo.

    \n

    You can see mostly type of article within this class and you for more detail, please see the remarks.

    \n

    \n

    this class is a template class. It has two Generic parameter. they are: T and K.

    \n

    The extension method of this class can refer to class

    \n", "remarks": "

    THIS is remarks overridden in MARKDWON file

    \n", "example": [ - "

    Here's example of how to create an instance of this class. As T is limited with class and K is limited with struct.

    \n
        var a = new Cat(object, int)();\n    int catNumber = new int();\n    unsafe\n    {\n        a.GetFeetLength(catNumber);\n    }
    \n

    As you see, here we bring in pointer so we need to add unsafe keyword.

    \n" + "

    Here's example of how to create an instance of this class. As T is limited with class and K is limited with struct.

    \n
    var a = new Cat(object, int)();\nint catNumber = new int();\nunsafe\n{\n    a.GetFeetLength(catNumber);\n}
    \n

    As you see, here we bring in pointer so we need to add unsafe keyword.

    \n" ], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json index cc045082d2a..f25fe0ad7de 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ColorType.html.view.verified.json @@ -177,7 +177,7 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

    blue

    \n", + "summary": "

    blue

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ColorType_Blue.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ColorType.Blue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L33", @@ -312,7 +312,7 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

    red

    \n", + "summary": "

    red

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ColorType_Red.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ColorType.Red%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L29", @@ -447,7 +447,7 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

    yellow

    \n", + "summary": "

    yellow

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ColorType_Yellow.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ColorType.Yellow%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L37", @@ -558,7 +558,7 @@ ], "level": 0.0 }, - "summary": "

    Enumeration ColorType

    \n", + "summary": "

    Enumeration ColorType

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json index 956da5d72ac..ced3eb14d1b 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.ContainersRefTypeDelegate.html.view.verified.json @@ -145,7 +145,7 @@ ], "level": 0.0 }, - "summary": "

    Delegate ContainersRefTypeDelegate

    \n", + "summary": "

    Delegate ContainersRefTypeDelegate

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.html.view.verified.json index ae764275ac6..52655cc23a5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.ContainersRefType.html.view.verified.json @@ -177,7 +177,7 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

    ColorCount

    \n", + "summary": "

    ColorCount

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ColorCount.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ColorCount%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L18", @@ -364,7 +364,7 @@ }, "level": 0.0, "type": "property", - "summary": "

    GetColorCount

    \n", + "summary": "

    GetColorCount

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_GetColorCount.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.GetColorCount%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L50", @@ -597,7 +597,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    ContainersRefTypeNonRefMethod

    \narray\n", + "summary": "

    ContainersRefTypeNonRefMethod

    \narray\n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Core_ContainersRefType_ContainersRefTypeNonRefMethod_System_Object___.md&value=---%0Auid%3A%20CatLibrary.Core.ContainersRefType.ContainersRefTypeNonRefMethod(System.Object%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary.Core/BaseClass.cs/#L68", @@ -850,7 +850,7 @@ ], "level": 0.0 }, - "summary": "

    Struct ContainersRefType

    \n", + "summary": "

    Struct ContainersRefType

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.html.view.verified.json index 9548621a1b1..2ab69582ffb 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Core.html.view.verified.json @@ -194,7 +194,7 @@ } ], "level": 0.0, - "summary": "

    Struct ContainersRefType

    \n", + "summary": "

    Struct ContainersRefType

    \n", "type": "struct", "platform": null, "isEii": false, @@ -329,7 +329,7 @@ } ], "level": 0.0, - "summary": "

    Enumeration ColorType

    \n", + "summary": "

    Enumeration ColorType

    \n", "type": "enum", "platform": null, "isEii": false, @@ -396,7 +396,7 @@ } ], "level": 0.0, - "summary": "

    Delegate ContainersRefTypeDelegate

    \n", + "summary": "

    Delegate ContainersRefTypeDelegate

    \n", "type": "delegate", "platform": null, "isEii": false, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.FakeDelegate-1.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.FakeDelegate-1.html.view.verified.json index 05a2f735fc5..2407659fdad 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.FakeDelegate-1.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.FakeDelegate-1.html.view.verified.json @@ -145,7 +145,7 @@ ], "level": 0.0 }, - "summary": "

    Fake delegate

    \n", + "summary": "

    Fake delegate

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.IAnimal.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.IAnimal.html.view.verified.json index fafb4990195..d26d43fcd87 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.IAnimal.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.IAnimal.html.view.verified.json @@ -271,7 +271,7 @@ }, "level": 0.0, "type": "property", - "summary": "

    Return specific number animal's name.

    \n", + "summary": "

    Return specific number animal's name.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_IAnimal_Item_System_Int32_.md&value=---%0Auid%3A%20CatLibrary.IAnimal.Item(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L29", @@ -451,7 +451,7 @@ }, "level": 0.0, "type": "property", - "summary": "

    Name of Animal.

    \n", + "summary": "

    Name of Animal.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_IAnimal_Name.md&value=---%0Auid%3A%20CatLibrary.IAnimal.Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L22", @@ -591,7 +591,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Animal's eat method.

    \n", + "summary": "

    Animal's eat method.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_IAnimal_Eat.md&value=---%0Auid%3A%20CatLibrary.IAnimal.Eat%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L34", @@ -773,7 +773,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Feed the animal with some food

    \n", + "summary": "

    Feed the animal with some food

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_IAnimal_Eat_System_String_.md&value=---%0Auid%3A%20CatLibrary.IAnimal.Eat(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L48", @@ -962,7 +962,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Overload method of eat. This define the animal eat by which tool.

    \n", + "summary": "

    Overload method of eat. This define the animal eat by which tool.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_IAnimal_Eat__1___0_.md&value=---%0Auid%3A%20CatLibrary.IAnimal.Eat%60%601(%60%600)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L41", @@ -1084,7 +1084,7 @@ ], "level": 0.0 }, - "summary": "

    This is basic interface of all animal.

    \n", + "summary": "

    This is basic interface of all animal.

    \n", "remarks": "

    THIS is remarks overridden in MARKDWON file

    \n", "example": [], "syntax": { diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICat.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICat.html.view.verified.json index 14e08f7a07b..eef206e38ca 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICat.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICat.html.view.verified.json @@ -177,7 +177,7 @@ "example": [], "level": 0.0, "type": "event", - "summary": "

    eat event of cat. Every cat must implement this event.

    \n", + "summary": "

    eat event of cat. Every cat must implement this event.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_ICat_eat.md&value=---%0Auid%3A%20CatLibrary.ICat.eat%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L60", @@ -288,7 +288,7 @@ ], "level": 0.0 }, - "summary": "

    Cat's interface

    \n", + "summary": "

    Cat's interface

    \n", "example": [], "syntax": { "content": [ @@ -349,7 +349,7 @@ } ], "level": 0.0, - "summary": "

    Name of Animal.

    \n", + "summary": "

    Name of Animal.

    \n", "type": "property", "platform": null, "isEii": false @@ -401,7 +401,7 @@ } ], "level": 0.0, - "summary": "

    Return specific number animal's name.

    \n", + "summary": "

    Return specific number animal's name.

    \n", "type": "property", "platform": null, "isEii": false @@ -451,7 +451,7 @@ } ], "level": 0.0, - "summary": "

    Animal's eat method.

    \n", + "summary": "

    Animal's eat method.

    \n", "type": "method", "platform": null, "isEii": false @@ -551,7 +551,7 @@ } ], "level": 0.0, - "summary": "

    Feed the animal with some food

    \n", + "summary": "

    Feed the animal with some food

    \n", "type": "method", "platform": null, "isEii": false diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICatExtension.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICatExtension.html.view.verified.json index 96071feffc3..1b047589bb6 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICatExtension.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.ICatExtension.html.view.verified.json @@ -271,7 +271,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Extension method to let cat play

    \n", + "summary": "

    Extension method to let cat play

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_ICatExtension_Play_CatLibrary_ICat_CatLibrary_Core_ContainersRefType_ColorType_.md&value=---%0Auid%3A%20CatLibrary.ICatExtension.Play(CatLibrary.ICat%2CCatLibrary.Core.ContainersRefType.ColorType)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L341", @@ -500,7 +500,7 @@ }, "level": 0.0, "type": "method", - "summary": "

    Extension method hint that how long the cat can sleep.

    \n", + "summary": "

    Extension method hint that how long the cat can sleep.

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_ICatExtension_Sleep_CatLibrary_ICat_System_Int64_.md&value=---%0Auid%3A%20CatLibrary.ICatExtension.Sleep(CatLibrary.ICat%2CSystem.Int64)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L334", @@ -611,7 +611,7 @@ ], "level": 0.0 }, - "summary": "

    It's the class that contains ICat interface's extension method.

    \n

    This class must be public and static.

    \n

    Also it shouldn't be a geneic class

    \n", + "summary": "

    It's the class that contains ICat interface's extension method.

    \n

    This class must be public and static.

    \n

    Also it shouldn't be a geneic class

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.MRefDelegate-3.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.MRefDelegate-3.html.view.verified.json index 7b7a3a736a3..6716168ceae 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.MRefDelegate-3.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.MRefDelegate-3.html.view.verified.json @@ -145,7 +145,7 @@ ], "level": 0.0 }, - "summary": "

    Generic delegate with many constrains.

    \n", + "summary": "

    Generic delegate with many constrains.

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.MRefNormalDelegate.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.MRefNormalDelegate.html.view.verified.json index ad11b44411b..af6980b31b2 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.MRefNormalDelegate.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.MRefNormalDelegate.html.view.verified.json @@ -145,7 +145,7 @@ ], "level": 0.0 }, - "summary": "

    Delegate in the namespace

    \n", + "summary": "

    Delegate in the namespace

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Tom.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Tom.html.view.verified.json index c766887770d..acc19a411f5 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Tom.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.Tom.html.view.verified.json @@ -460,7 +460,7 @@ ], "level": 0.0, "type": "method", - "summary": "

    This is a Tom Method with complex type as return

    \n", + "summary": "

    This is a Tom Method with complex type as return

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_Tom_TomMethod_CatLibrary_Complex_CatLibrary_TomFromBaseClass_CatLibrary_TomFromBaseClass__System_Tuple_System_String_CatLibrary_Tom__.md&value=---%0Auid%3A%20CatLibrary.Tom.TomMethod(CatLibrary.Complex%7BCatLibrary.TomFromBaseClass%2CCatLibrary.TomFromBaseClass%7D%2CSystem.Tuple%7BSystem.String%2CCatLibrary.Tom%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L294", @@ -571,7 +571,7 @@ ], "level": 0.0 }, - "summary": "

    Tom class is only inherit from Object. Not any member inside itself.

    \n", + "summary": "

    Tom class is only inherit from Object. Not any member inside itself.

    \n", "example": [], "syntax": { "content": [ diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.TomFromBaseClass.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.TomFromBaseClass.html.view.verified.json index 0bd0712de50..4d848132c61 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.TomFromBaseClass.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.TomFromBaseClass.html.view.verified.json @@ -224,7 +224,7 @@ }, "level": 0.0, "type": "constructor", - "summary": "

    This is a #ctor with parameter

    \n", + "summary": "

    This is a #ctor with parameter

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CatLibrary_TomFromBaseClass__ctor_System_Int32_.md&value=---%0Auid%3A%20CatLibrary.TomFromBaseClass.%23ctor(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L310", @@ -335,7 +335,7 @@ ], "level": 0.0 }, - "summary": "

    TomFromBaseClass inherits from @

    \n", + "summary": "

    TomFromBaseClass inherits from @

    \n", "example": [], "syntax": { "content": [ @@ -498,7 +498,7 @@ } ], "level": 0.0, - "summary": "

    This is a Tom Method with complex type as return

    \n", + "summary": "

    This is a Tom Method with complex type as return

    \n", "type": "method", "platform": null, "isEii": false diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json index 9e78305f931..177baa176f4 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/CatLibrary.html.view.verified.json @@ -120,7 +120,7 @@ } ], "level": 0.0, - "summary": "

    Here's main class of this Demo.

    \n

    You can see mostly type of article within this class and you for more detail, please see the remarks.

    \n

    \n

    this class is a template class. It has two Generic parameter. they are: T and K.

    \n

    The extension method of this class can refer to class

    \n", + "summary": "

    Here's main class of this Demo.

    \n

    You can see mostly type of article within this class and you for more detail, please see the remarks.

    \n

    \n

    this class is a template class. It has two Generic parameter. they are: T and K.

    \n

    The extension method of this class can refer to class

    \n", "type": "class", "platform": null, "isEii": false, @@ -301,7 +301,7 @@ } ], "level": 0.0, - "summary": "

    It's the class that contains ICat interface's extension method.

    \n

    This class must be public and static.

    \n

    Also it shouldn't be a geneic class

    \n", + "summary": "

    It's the class that contains ICat interface's extension method.

    \n

    This class must be public and static.

    \n

    Also it shouldn't be a geneic class

    \n", "type": "class", "platform": null, "isEii": false, @@ -362,7 +362,7 @@ } ], "level": 0.0, - "summary": "

    Tom class is only inherit from Object. Not any member inside itself.

    \n", + "summary": "

    Tom class is only inherit from Object. Not any member inside itself.

    \n", "type": "class", "platform": null, "isEii": false, @@ -422,7 +422,7 @@ } ], "level": 0.0, - "summary": "

    TomFromBaseClass inherits from @

    \n", + "summary": "

    TomFromBaseClass inherits from @

    \n", "type": "class", "platform": null, "isEii": false, @@ -490,7 +490,7 @@ } ], "level": 0.0, - "summary": "

    This is basic interface of all animal.

    \n", + "summary": "

    This is basic interface of all animal.

    \n", "type": "interface", "platform": null, "isEii": false, @@ -551,7 +551,7 @@ } ], "level": 0.0, - "summary": "

    Cat's interface

    \n", + "summary": "

    Cat's interface

    \n", "type": "interface", "platform": null, "isEii": false, @@ -618,7 +618,7 @@ } ], "level": 0.0, - "summary": "

    Fake delegate

    \n", + "summary": "

    Fake delegate

    \n", "type": "delegate", "platform": null, "isEii": false, @@ -678,7 +678,7 @@ } ], "level": 0.0, - "summary": "

    Generic delegate with many constrains.

    \n", + "summary": "

    Generic delegate with many constrains.

    \n", "type": "delegate", "platform": null, "isEii": false, @@ -738,7 +738,7 @@ } ], "level": 0.0, - "summary": "

    Delegate in the namespace

    \n", + "summary": "

    Delegate in the namespace

    \n", "type": "delegate", "platform": null, "isEii": false, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.ColorType.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.ColorType.html.view.verified.json index 5ccf1215a62..7a9466e7548 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.ColorType.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.ColorType.html.view.verified.json @@ -177,7 +177,7 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

    blue like river

    \n", + "summary": "

    blue like river

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=MRef_Demo_Enumeration_ColorType_Blue.md&value=---%0Auid%3A%20MRef.Demo.Enumeration.ColorType.Blue%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L409", @@ -312,7 +312,7 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

    this color is red

    \n", + "summary": "

    this color is red

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=MRef_Demo_Enumeration_ColorType_Red.md&value=---%0Auid%3A%20MRef.Demo.Enumeration.ColorType.Red%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L405", @@ -447,7 +447,7 @@ "example": [], "level": 0.0, "type": "field", - "summary": "

    yellow comes from desert

    \n", + "summary": "

    yellow comes from desert

    \n", "platform": null, "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=MRef_Demo_Enumeration_ColorType_Yellow.md&value=---%0Auid%3A%20MRef.Demo.Enumeration.ColorType.Yellow%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A", "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/solution/CatLibrary/Class1.cs/#L413", @@ -558,7 +558,7 @@ ], "level": 0.0 }, - "summary": "

    Enumeration ColorType

    \n", + "summary": "

    Enumeration ColorType

    \n", "remarks": "

    \nRed/Blue/Yellow can become all color you want.\n

    \n
      \n", "example": [], "syntax": { diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.html.view.verified.json index 1c714f40a6b..7b53c110c2f 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.html.view.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/MRef.Demo.Enumeration.html.view.verified.json @@ -53,7 +53,7 @@ } ], "level": 0.0, - "summary": "

      Enumeration ColorType

      \n", + "summary": "

      Enumeration ColorType

      \n", "type": "enum", "platform": null, "isEii": false, diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json index 7b2aeeb415e..b27e3c9be97 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json @@ -22,7 +22,7 @@ "api/BuildFromProject.Class1.html": { "href": "api/BuildFromProject.Class1.html", "title": "Class Class1 | docfx seed website", - "keywords": "Class Class1 Namespace BuildFromProject Assembly BuildFromProject.dll public class Class1 Inheritance object Class1 Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Issue1651() Pricing models are used to calculate theoretical option values 1Black Scholes 2Black76 3Black76Fut 4Equity Tree 5Variance Swap 6Dividend Forecast public void Issue1651() Issue7484() public void Issue7484() Remarks There's really no reason to not believe that this class can test things. Term Description A Term A Description Bee Term Bee Description Issue896() Test public void Issue896() See Also Class1.Test XmlCommentIncludeTag() This method should do something... public void XmlCommentIncludeTag() Remarks This is remarks." + "keywords": "Class Class1 Namespace BuildFromProject Assembly BuildFromProject.dll public class Class1 Inheritance object Class1 Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Issue1651() Pricing models are used to calculate theoretical option values 1Black Scholes 2Black76 3Black76Fut 4Equity Tree 5Variance Swap 6Dividend Forecast public void Issue1651() Issue2623() public void Issue2623() Examples MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } Remarks For example: MyClass myClass = new MyClass(); void Update() { myClass.Execute(); } Issue4017() public void Issue4017() Examples public void HookMessageDeleted(BaseSocketClient client) { client.MessageDeleted += HandleMessageDelete; } public Task HandleMessageDelete(Cacheable cachedMessage, ISocketMessageChannel channel) { // check if the message exists in cache; if not, we cannot report what was removed if (!cachedMessage.HasValue) return; var message = cachedMessage.Value; Console.WriteLine($\"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):\" + Environment.NewLine + message.Content); return Task.CompletedTask; } Remarks void Update() { myClass.Execute(); } Issue7484() public void Issue7484() Remarks There's really no reason to not believe that this class can test things. Term Description A Term A Description Bee Term Bee Description Issue896() Test public void Issue896() See Also Class1.Test XmlCommentIncludeTag() This method should do something... public void XmlCommentIncludeTag() Remarks This is remarks." }, "api/BuildFromProject.Class1.Test-1.html": { "href": "api/BuildFromProject.Class1.Test-1.html", diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/xrefmap.verified.yml b/test/docfx.Snapshot.Tests/SamplesTest.Seed/xrefmap.verified.yml index ca7e7aea2f3..b01eecd3b43 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.Seed/xrefmap.verified.yml +++ b/test/docfx.Snapshot.Tests/SamplesTest.Seed/xrefmap.verified.yml @@ -96,6 +96,32 @@ references: isSpec: "True" fullName: BuildFromProject.Class1.Issue1651 nameWithType: Class1.Issue1651 +- uid: BuildFromProject.Class1.Issue2623 + name: Issue2623() + href: api/BuildFromProject.Class1.html#BuildFromProject_Class1_Issue2623 + commentId: M:BuildFromProject.Class1.Issue2623 + fullName: BuildFromProject.Class1.Issue2623() + nameWithType: Class1.Issue2623() +- uid: BuildFromProject.Class1.Issue2623* + name: Issue2623 + href: api/BuildFromProject.Class1.html#BuildFromProject_Class1_Issue2623_ + commentId: Overload:BuildFromProject.Class1.Issue2623 + isSpec: "True" + fullName: BuildFromProject.Class1.Issue2623 + nameWithType: Class1.Issue2623 +- uid: BuildFromProject.Class1.Issue4017 + name: Issue4017() + href: api/BuildFromProject.Class1.html#BuildFromProject_Class1_Issue4017 + commentId: M:BuildFromProject.Class1.Issue4017 + fullName: BuildFromProject.Class1.Issue4017() + nameWithType: Class1.Issue4017() +- uid: BuildFromProject.Class1.Issue4017* + name: Issue4017 + href: api/BuildFromProject.Class1.html#BuildFromProject_Class1_Issue4017_ + commentId: Overload:BuildFromProject.Class1.Issue4017 + isSpec: "True" + fullName: BuildFromProject.Class1.Issue4017 + nameWithType: Class1.Issue4017 - uid: BuildFromProject.Class1.Issue7484 name: Issue7484() href: api/BuildFromProject.Class1.html#BuildFromProject_Class1_Issue7484 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-BuildFromProject.Class1.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-BuildFromProject.Class1.html.verified.png index 9de701eff2c..cfa2d70cab7 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-BuildFromProject.Class1.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1152x648/api-BuildFromProject.Class1.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:b8aa69c2c30d4690c6fc8da9e6985a04702d2e6b42a70e7529a0acdd9bfba626 -size 118717 +oid sha256:e104571d26bc36b7efeb49f071af2a26d2ad42fca45509f8289c34a4b9614298 +size 122216 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-BuildFromProject.Class1.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-BuildFromProject.Class1.html.verified.png index 9099bc8f807..1b06a1f0e98 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-BuildFromProject.Class1.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-BuildFromProject.Class1.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:be68abd444de7868304947429eb25c3f4288b281f046cc9149769056c76a32ff -size 228306 +oid sha256:e26820a026280c77355f767ca6c2c471a3fdbc1a8aefd7279ef045714ef84154 +size 365198 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.Cat-2.html-q-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.Cat-2.html-q-cat.verified.png index 779f6b4a855..6eb74bcca75 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.Cat-2.html-q-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/1920x1080/api-CatLibrary.Cat-2.html-q-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:1a0c445b3041039a191409f347160462c01b8ad15e3500cc6ec6cccef4b45a3b -size 839675 +oid sha256:7ebcb7d25d2e54eb47e2a06288255b94dab85b9487800e6c6f1ff8df338d4f89 +size 839523 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-BuildFromProject.Class1.html.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-BuildFromProject.Class1.html.verified.png index af9b8d198d7..799b6d2b716 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-BuildFromProject.Class1.html.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-BuildFromProject.Class1.html.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:d333e461c0e9e9bede7bc301fa5da5ce1f027c6cfd57c897bfe038a10f89225e -size 154287 +oid sha256:27d48849df6281752a8243cef194a2c2349ed15bd7e0dcedcf38982f6da06612 +size 244647 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.Cat-2.html-q-cat.verified.png b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.Cat-2.html-q-cat.verified.png index 54e4503919a..3ddf65a4fa8 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.Cat-2.html-q-cat.verified.png +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/375x812/api-CatLibrary.Cat-2.html-q-cat.verified.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:2c466a3ce53d915d5547d8c3a43e3d9fb91cb8289f280e880010845a687420cc -size 667435 +oid sha256:055e9cb4c9f9c80f0f9bfebe2905ff237b52437f4527467f6d39c3e73aa302a3 +size 667705 diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html index c136f15021d..4c3cc4d5006 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html @@ -526,7 +526,7 @@

      Methods Issue1651() - +

      Pricing models are used to calculate theoretical option values

      @@ -550,11 +550,105 @@

      + +

      + Issue2623() + +

      + +
      +
      + +
      +
      public void Issue2623()
      +
      + + + + + + + + +

      Examples

      +
      MyClass myClass = new MyClass();
      +
      +void Update()
      +{
      +    myClass.Execute();
      +}
      +
      + + +

      Remarks

      +

      For example:

      +
      MyClass myClass = new MyClass();
      +
      +void Update()
      +{
      +    myClass.Execute();
      +}
      +
      +
      + + + + + + +

      + Issue4017() + +

      + +
      +
      + +
      +
      public void Issue4017()
      +
      + + + + + + + + +

      Examples

      +
      public void HookMessageDeleted(BaseSocketClient client)
      +{
      +    client.MessageDeleted += HandleMessageDelete;
      +}
      +
      +public Task HandleMessageDelete(Cacheable<IMessage, ulong> cachedMessage, ISocketMessageChannel channel)
      +{
      +    // check if the message exists in cache; if not, we cannot report what was removed
      +    if (!cachedMessage.HasValue) return;
      +    var message = cachedMessage.Value;
      +    Console.WriteLine($"A message ({message.Id}) from {message.Author} was removed from the channel {channel.Name} ({channel.Id}):"
      +        + Environment.NewLine
      +        + message.Content);
      +    return Task.CompletedTask;
      +}
      + + +

      Remarks

      +
      void Update()
      +{
      +    myClass.Execute();
      +}
      +
      + + + +

      Issue7484() - +

      @@ -584,7 +678,7 @@

      Remarks Issue896() - +

      Test

      @@ -619,7 +713,7 @@

      XmlCommentIncludeTag() - +

      This method should do something...

      @@ -656,7 +750,7 @@

      Re diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html index e521f87a5bb..9ce6612b4dd 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html @@ -468,10 +468,10 @@

      Assembly
      CatLibrary.dll

      -

      Here's main class of this Demo.

      +

      Here's main class of this Demo.

      You can see mostly type of article within this class and you for more detail, please see the remarks.

      -

      this class is a template class. It has two Generic parameter. they are: T and K.

      +

      this class is a template class. It has two Generic parameter. they are: T and K.

      The extension method of this class can refer to ICatExtension class

      @@ -554,13 +554,13 @@

      Type ParametersExamples

      Here's example of how to create an instance of this class. As T is limited with class and K is limited with struct.

      -
          var a = new Cat(object, int)();
      -    int catNumber = new int();
      -    unsafe
      -    {
      -        a.GetFeetLength(catNumber);
      -    }
      -

      As you see, here we bring in pointer so we need to add unsafe keyword.

      +
      var a = new Cat(object, int)();
      +int catNumber = new int();
      +unsafe
      +{
      +    a.GetFeetLength(catNumber);
      +}
      +

      As you see, here we bring in pointer so we need to add unsafe keyword.

      Remarks

      @@ -912,7 +912,7 @@

      It's an unsafe method. -As you see, catName is a pointer, so we need to add unsafe keyword.

      +As you see, catName is a pointer, so we need to add unsafe keyword.

      @@ -1058,7 +1058,7 @@

      ParametersReturns

      int
      -

      Result with int type.

      +

      Result with int type.

      diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html index f5e6eb08de0..927040e2b25 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html-term-cat.verified.html @@ -469,10 +469,10 @@

      Classes

      Cat<T, K>
      -

      Here's main class of this Demo.

      +

      Here's main class of this Demo.

      You can see mostly type of article within this class and you for more detail, please see the remarks.

      -

      this class is a template class. It has two Generic parameter. they are: T and K.

      +

      this class is a template class. It has two Generic parameter. they are: T and K.

      The extension method of this class can refer to ICatExtension class

      @@ -487,7 +487,7 @@

      Classes
      ICatExtension

      It's the class that contains ICat interface's extension method.

      -

      This class must be public and static.

      +

      This class must be public and static.

      Also it shouldn't be a geneic class

      @@ -504,7 +504,7 @@

      ClassesInterfaces

      IAnimal
      -

      This is basic interface of all animal.

      +

      This is basic interface of all animal.

      diff --git a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html index 6c919626614..a490df831d0 100644 --- a/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html +++ b/test/docfx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.html.verified.html @@ -469,10 +469,10 @@

      Classes

      Cat<T, K>
      -

      Here's main class of this Demo.

      +

      Here's main class of this Demo.

      You can see mostly type of article within this class and you for more detail, please see the remarks.

      -

      this class is a template class. It has two Generic parameter. they are: T and K.

      +

      this class is a template class. It has two Generic parameter. they are: T and K.

      The extension method of this class can refer to ICatExtension class

      @@ -487,7 +487,7 @@

      Classes
      ICatExtension

      It's the class that contains ICat interface's extension method.

      -

      This class must be public and static.

      +

      This class must be public and static.

      Also it shouldn't be a geneic class

      @@ -504,7 +504,7 @@

      ClassesInterfaces

      IAnimal
      -

      This is basic interface of all animal.

      +

      This is basic interface of all animal.