Class BaseDocumentationInfo
Represents a documentation of a code part.
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
Namespace: IRM.Xml
Assembly: IRM.dll
Syntax
public abstract class BaseDocumentationInfo
Properties
FullTypeName
Gets or sets the full type name of the System.Type that this instance documents.
Declaration
public string FullTypeName { get; set; }
Property Value
String
|
Id
Gets a unique identifier for the code part that this instance documents.
Declaration
public string Id { get; set; }
Property Value
String
|
Remarks
Id, sätts idag till "member name" ifrån dokumentation, t ex T:Dtos.Order för typ, M:Dtos.Order.Beräkna(System.Decimal) för metod, P:Dtos.Order.Id för property, för en parameter så sätts id till parameterns namn.
Remarks
Gets or sets the remarks documentation.
Declaration
public virtual DocumentationPart Remarks { get; set; }
Property Value
DocumentationPart
|
Returns
Gets or sets the returns documentation.
Declaration
public virtual DocumentationPart Returns { get; set; }
Property Value
DocumentationPart
|
Summary
Gets or sets the summary documentation.
Declaration
public virtual DocumentationPart Summary { get; set; }
Property Value
DocumentationPart
|
Value
Gets or sets the value documentation.
Declaration
public virtual DocumentationPart Value { get; set; }
Property Value
DocumentationPart
|