fix: suppress snapshot test warning (#8936)

dotnet · Jul 5, 2023 · a0832df · a0832df
1 parent 43bda19
commit a0832df
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/samples/seed/dotnet/assembly/Class1.cs b/samples/seed/dotnet/assembly/Class1.cs
@@ -7,8 +7,14 @@ namespace BuildFromAssembly;
 /// </summary>
 public class Class1
 {
+    /// <summary>
+    /// Hello World.
+    /// </summary>
     public static void HelloWorld() { }
 
+    /// <summary>
+    /// Hidden API.
+    /// </summary>
     [EditorBrowsable(EditorBrowsableState.Never)]
     public void HiddenAPI() { }
 }
diff --git a/...ocfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.Class1.html.view.verified.json b/...ocfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromAssembly.Class1.html.view.verified.json
@@ -258,6 +258,7 @@
             "BuildFromAssembly"
           ],
           "namespace": "BuildFromAssembly",
+          "example": [],
           "overload": {
             "uid": "BuildFromAssembly.Class1.HelloWorld*",
             "name": [
@@ -304,14 +305,13 @@
           },
           "level": 0.0,
           "type": "method",
-          "summary": "",
+          "summary": "<p sourcefile=\"obj/api/BuildFromAssembly.Class1.yml\" sourcestartlinenumber=\"1\">Hello World.</p>\n",
           "platform": null,
           "docurl": "",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/dotnet/assembly/Class1.cs",
           "remarks": "",
           "conceptual": "",
           "implements": "",
-          "example": "",
           "seealso": null,
           "id": "BuildFromAssembly_Class1_HelloWorld",
           "hideTitleType": false,

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json
@@ -2,7 +2,7 @@
   "api/BuildFromAssembly.Class1.html": {
     "href": "api/BuildFromAssembly.Class1.html",
     "title": "Class Class1 | docfx seed website",
-    "keywords": "Class Class1 Namespace BuildFromAssembly Assembly BuildFromAssembly.dll This is a test class. public class Class1 Inheritance object Class1 Inherited Members object.GetType() object.MemberwiseClone() object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() Constructors Class1() public Class1() Methods HelloWorld() public static void HelloWorld()"
+    "keywords": "Class Class1 Namespace BuildFromAssembly Assembly BuildFromAssembly.dll This is a test class. public class Class1 Inheritance object Class1 Inherited Members object.GetType() object.MemberwiseClone() object.ToString() object.Equals(object) object.Equals(object, object) object.ReferenceEquals(object, object) object.GetHashCode() Constructors Class1() public Class1() Methods HelloWorld() Hello World. public static void HelloWorld()"
   },
   "api/BuildFromAssembly.html": {
     "href": "api/BuildFromAssembly.html",