property, field return value; method code block

k-wojcik · Mar 20, 2024 · 8e3358f · 8e3358f
1 parent 07cbc7b
commit 8e3358f
Show file tree

Hide file tree

Showing 40 changed files with 962 additions and 155 deletions.
diff --git a/api/.manifest b/api/.manifest
@@ -2,6 +2,9 @@
   "DocFxToTemplate": "DocFxToTemplate.yml",
   "DocFxToTemplate.Example1": "DocFxToTemplate.Example1.yml",
   "DocFxToTemplate.Example1.Class1": "DocFxToTemplate.Example1.Class1.yml",
+  "DocFxToTemplate.Example1.Class1._field1": "DocFxToTemplate.Example1.Class1.yml",
+  "DocFxToTemplate.Example1.Class1.Method1(System.String)": "DocFxToTemplate.Example1.Class1.yml",
+  "DocFxToTemplate.Example1.Class1.Property1": "DocFxToTemplate.Example1.Class1.yml",
   "DocFxToTemplate.Example1.Enum1": "DocFxToTemplate.Example1.Enum1.yml",
   "DocFxToTemplate.Example1.Flags1": "DocFxToTemplate.Example1.Flags1.yml",
   "DocFxToTemplate.Example1.Flags1.Flag1": "DocFxToTemplate.Example1.Flags1.yml",

diff --git a/api/DocFxToTemplate.Example1.Class1.yml b/api/DocFxToTemplate.Example1.Class1.yml
@@ -4,7 +4,10 @@ items:
   commentId: T:DocFxToTemplate.Example1.Class1
   id: Class1
   parent: DocFxToTemplate.Example1
-  children: []
+  children:
+  - DocFxToTemplate.Example1.Class1.Method1(System.String)
+  - DocFxToTemplate.Example1.Class1.Property1
+  - DocFxToTemplate.Example1.Class1._field1
   langs:
   - csharp
   - vb
@@ -36,6 +39,96 @@ items:
   - System.Object.MemberwiseClone
   - System.Object.ReferenceEquals(System.Object,System.Object)
   - System.Object.ToString
+- uid: DocFxToTemplate.Example1.Class1._field1
+  commentId: F:DocFxToTemplate.Example1.Class1._field1
+  id: _field1
+  parent: DocFxToTemplate.Example1.Class1
+  langs:
+  - csharp
+  - vb
+  name: _field1
+  nameWithType: Class1._field1
+  fullName: DocFxToTemplate.Example1.Class1._field1
+  type: Field
+  source:
+    remote:
+      path: src/example/DocFxToTemplate.Example1/Class1.cs
+      branch: master
+      repo: [email protected]:k-wojcik/DocFxToTemplate.git
+    id: _field1
+    path: src/example/DocFxToTemplate.Example1/Class1.cs
+    startLine: 4
+  assemblies:
+  - DocFxToTemplate.Example1
+  namespace: DocFxToTemplate.Example1
+  syntax:
+    content: public string _field1
+    return:
+      type: System.String
+    content.vb: Public _field1 As String
+- uid: DocFxToTemplate.Example1.Class1.Property1
+  commentId: P:DocFxToTemplate.Example1.Class1.Property1
+  id: Property1
+  parent: DocFxToTemplate.Example1.Class1
+  langs:
+  - csharp
+  - vb
+  name: Property1
+  nameWithType: Class1.Property1
+  fullName: DocFxToTemplate.Example1.Class1.Property1
+  type: Property
+  source:
+    remote:
+      path: src/example/DocFxToTemplate.Example1/Class1.cs
+      branch: master
+      repo: [email protected]:k-wojcik/DocFxToTemplate.git
+    id: Property1
+    path: src/example/DocFxToTemplate.Example1/Class1.cs
+    startLine: 6
+  assemblies:
+  - DocFxToTemplate.Example1
+  namespace: DocFxToTemplate.Example1
+  syntax:
+    content: public string Property1 { get; set; }
+    parameters: []
+    return:
+      type: System.String
+    content.vb: Public Property Property1 As String
+  overload: DocFxToTemplate.Example1.Class1.Property1*
+- uid: DocFxToTemplate.Example1.Class1.Method1(System.String)
+  commentId: M:DocFxToTemplate.Example1.Class1.Method1(System.String)
+  id: Method1(System.String)
+  parent: DocFxToTemplate.Example1.Class1
+  langs:
+  - csharp
+  - vb
+  name: Method1(string)
+  nameWithType: Class1.Method1(string)
+  fullName: DocFxToTemplate.Example1.Class1.Method1(string)
+  type: Method
+  source:
+    remote:
+      path: src/example/DocFxToTemplate.Example1/Class1.cs
+      branch: master
+      repo: [email protected]:k-wojcik/DocFxToTemplate.git
+    id: Method1
+    path: src/example/DocFxToTemplate.Example1/Class1.cs
+    startLine: 8
+  assemblies:
+  - DocFxToTemplate.Example1
+  namespace: DocFxToTemplate.Example1
+  syntax:
+    content: public Task Method1(string input1)
+    parameters:
+    - id: input1
+      type: System.String
+    return:
+      type: System.Threading.Tasks.Task
+    content.vb: Public Function Method1(input1 As String) As Task
+  overload: DocFxToTemplate.Example1.Class1.Method1*
+  nameWithType.vb: Class1.Method1(String)
+  fullName.vb: DocFxToTemplate.Example1.Class1.Method1(String)
+  name.vb: Method1(String)
 references:
 - uid: DocFxToTemplate.Example1
   commentId: N:DocFxToTemplate.Example1
@@ -296,3 +389,71 @@ references:
   name: System
   nameWithType: System
   fullName: System
+- uid: System.String
+  commentId: T:System.String
+  parent: System
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.string
+  name: string
+  nameWithType: string
+  fullName: string
+  nameWithType.vb: String
+  fullName.vb: String
+  name.vb: String
+- uid: DocFxToTemplate.Example1.Class1.Property1*
+  commentId: Overload:DocFxToTemplate.Example1.Class1.Property1
+  href: DocFxToTemplate.Example1.Class1.html#DocFxToTemplate_Example1_Class1_Property1
+  name: Property1
+  nameWithType: Class1.Property1
+  fullName: DocFxToTemplate.Example1.Class1.Property1
+- uid: DocFxToTemplate.Example1.Class1.Method1*
+  commentId: Overload:DocFxToTemplate.Example1.Class1.Method1
+  href: DocFxToTemplate.Example1.Class1.html#DocFxToTemplate_Example1_Class1_Method1_System_String_
+  name: Method1
+  nameWithType: Class1.Method1
+  fullName: DocFxToTemplate.Example1.Class1.Method1
+- uid: System.Threading.Tasks.Task
+  commentId: T:System.Threading.Tasks.Task
+  parent: System.Threading.Tasks
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.threading.tasks.task
+  name: Task
+  nameWithType: Task
+  fullName: System.Threading.Tasks.Task
+- uid: System.Threading.Tasks
+  commentId: N:System.Threading.Tasks
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system
+  name: System.Threading.Tasks
+  nameWithType: System.Threading.Tasks
+  fullName: System.Threading.Tasks
+  spec.csharp:
+  - uid: System
+    name: System
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system
+  - name: .
+  - uid: System.Threading
+    name: Threading
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.threading
+  - name: .
+  - uid: System.Threading.Tasks
+    name: Tasks
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.threading.tasks
+  spec.vb:
+  - uid: System
+    name: System
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system
+  - name: .
+  - uid: System.Threading
+    name: Threading
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.threading
+  - name: .
+  - uid: System.Threading.Tasks
+    name: Tasks
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.threading.tasks
diff --git a/docs/docs/api/DocFxToTemplate.Example1/Class1.md b/docs/docs/api/DocFxToTemplate.Example1/Class1.md
@@ -23,8 +23,44 @@ public class Class1
 
 
 
+## Properties
+### Property1
 
+
+```csharp title="src/example/DocFxToTemplate.Example1/Class1.cs#L7"
+public string Property1 { get; set; }
+```   
 
+#### Property value
+[string](https://learn.microsoft.com/dotnet/api/system.string)   
+   
+
+
+## Fields
+### _field1
+
+
+```csharp title="src/example/DocFxToTemplate.Example1/Class1.cs#L5"
+public string _field1
+```
+
+#### Field value
+[string](https://learn.microsoft.com/dotnet/api/system.string)   
+   
+
+
+## Methods
+### Method1(string)
+
+```csharp title="src/example/DocFxToTemplate.Example1/Class1.cs#L9"
+public Task Method1(string input1)
+```
+
+#### Parameters
+`input1` [string](https://learn.microsoft.com/dotnet/api/system.string)   
+   
+#### Returns
+ [Task](https://learn.microsoft.com/dotnet/api/system.threading.tasks.task)    
    
 
 

diff --git a/docs/docs/api/DocFxToTemplate.Example1/Flags1.md b/docs/docs/api/DocFxToTemplate.Example1/Flags1.md
@@ -26,14 +26,24 @@ public enum Flags1
 ## Fields
 ### Flag1
 
+
 ```csharp title="src/example/DocFxToTemplate.Example1/Flags1.cs#L6"
 Flag1 = 0
 ```
+
+#### Field value
+[Flags1](../DocFxToTemplate.Example1/Flags1)   
+
 ### Flag2
 
+
 ```csharp title="src/example/DocFxToTemplate.Example1/Flags1.cs#L7"
 Flag2 = 1
 ```
+
+#### Field value
+[Flags1](../DocFxToTemplate.Example1/Flags1)   
+
 
 
 

diff --git a/docs/docs/api/DocFxToTemplate.Models.DocFx.Attributes/MergeOption.md b/docs/docs/api/DocFxToTemplate.Models.DocFx.Attributes/MergeOption.md
@@ -25,19 +25,34 @@ public enum MergeOption
 ## Fields
 ### MergeKey
 
+
 ```csharp title="src/DocFxToTemplate/Models/DocFx/Attributes/MergeOptionAttribute.cs#L12"
 MergeKey = 0
 ```
+
+#### Field value
+[MergeOption](../DocFxToTemplate.Models.DocFx.Attributes/MergeOption)   
+
 ### Ignore
 
+
 ```csharp title="src/DocFxToTemplate/Models/DocFx/Attributes/MergeOptionAttribute.cs#L13"
 Ignore = 1
 ```
+
+#### Field value
+[MergeOption](../DocFxToTemplate.Models.DocFx.Attributes/MergeOption)   
+
 ### Replace
 
+
 ```csharp title="src/DocFxToTemplate/Models/DocFx/Attributes/MergeOptionAttribute.cs#L14"
 Replace = 2
 ```
+
+#### Field value
+[MergeOption](../DocFxToTemplate.Models.DocFx.Attributes/MergeOption)   
+
 
 
 

diff --git a/docs/docs/api/DocFxToTemplate.Models.DocFx/AdditionalNotes.md b/docs/docs/api/DocFxToTemplate.Models.DocFx/AdditionalNotes.md
@@ -33,7 +33,7 @@ public class AdditionalNotes
 public string Caller { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [string](https://learn.microsoft.com/dotnet/api/system.string)   
    
 ### Implementer
@@ -45,7 +45,7 @@ public string Caller { get; set; }
 public string Implementer { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [string](https://learn.microsoft.com/dotnet/api/system.string)   
    
 ### Inheritor
@@ -57,7 +57,7 @@ public string Implementer { get; set; }
 public string Inheritor { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [string](https://learn.microsoft.com/dotnet/api/system.string)   
    
 

diff --git a/docs/docs/api/DocFxToTemplate.Models.DocFx/ApiParameter.md b/docs/docs/api/DocFxToTemplate.Models.DocFx/ApiParameter.md
@@ -34,7 +34,7 @@ public class ApiParameter
 public string Name { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [string](https://learn.microsoft.com/dotnet/api/system.string)   
    
 ### Type
@@ -46,7 +46,7 @@ public string Name { get; set; }
 public string Type { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [string](https://learn.microsoft.com/dotnet/api/system.string)   
    
 ### Description
@@ -58,7 +58,7 @@ public string Type { get; set; }
 public string Description { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [string](https://learn.microsoft.com/dotnet/api/system.string)   
    
 ### Attributes
@@ -71,7 +71,7 @@ public string Description { get; set; }
 public List<AttributeInfo> Attributes { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [List](https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1)&lt;[AttributeInfo](../DocFxToTemplate.Models.DocFx/AttributeInfo)&gt;   
    
 ### Reference
@@ -84,7 +84,7 @@ public List<AttributeInfo> Attributes { get; set; }
 public ReferenceViewModel? Reference { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [ReferenceViewModel](../DocFxToTemplate.Models.DocFx/ReferenceViewModel)   
 
 

diff --git a/docs/docs/api/DocFxToTemplate.Models.DocFx/ArgumentInfo.md b/docs/docs/api/DocFxToTemplate.Models.DocFx/ArgumentInfo.md
@@ -33,7 +33,7 @@ public class ArgumentInfo
 public string Type { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [string](https://learn.microsoft.com/dotnet/api/system.string)   
    
 ### Value
@@ -45,7 +45,7 @@ public string Type { get; set; }
 public object Value { get; set; }
 ```   
 
-#### Property Value
+#### Property value
 [object](https://learn.microsoft.com/dotnet/api/system.object)