Class SourceInfoSummary
Summary text describing SourceInfo
Inheritance
object
SourceInfoSummary
Namespace: BuildSystem.GenDoc.DocFX
Assembly: BuildSystem.GenDoc.DocFX.dll
Syntax
public class SourceInfoSummary : ObjectConstructors
SourceInfoSummary()
Declaration
public SourceInfoSummary()Properties
MainSummary
Text of main description of object
Declaration
public string? MainSummary { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Params
List of params and their summary
Declaration
public Dictionary<string, string>? Params { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<,><string, string> |
Remarks
Describing of remarks
Declaration
public string? Remarks { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Return
Description of return value
Declaration
public string? Return { get; set; }Property Value
| Type | Description |
|---|---|
| string |
SeeAlso
Describing of see also
Declaration
public string? SeeAlso { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
ReadSummaryXml(XmlNode?)
Read XML with summary
Declaration
public static SourceInfoSummary? ReadSummaryXml(XmlNode? xmlNode)Parameters
| Type | Name | Description |
|---|---|---|
| System.Xml.XmlNode | xmlNode |
Returns
| Type | Description |
|---|---|
| SourceInfoSummary |