Class SourceInfo

SourceInfo about object which will be extracted to DocFX YML

Inheritance

object

SourceInfo

Namespace: BuildSystem.GenDoc.DocFX

Assembly: BuildSystem.GenDoc.DocFX.dll

Syntax

public class SourceInfo : Object

Constructors

SourceInfo()

Declaration

public SourceInfo()

Properties

Assembly

Assembly name

Declaration

public string? Assembly { get; set; }

Property Value

Type	Description
string

Examples

Binder

Children

List of another objects which has this object in Parent value. Exists only for classes and interfaces - here is list of properties and methods

Declaration

public List<string> Children { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<><string>

CommentId

Uid with type of object - the same format as in XML from C# compilation

Declaration

public string? CommentId { get; set; }

Property Value

Type	Description
string

Examples

T:Binder.BinderProps

DerivedClasses

List of classes, which inherit from current

Declaration

public List<string> DerivedClasses { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<><string>

FullName

Name with Uid

Declaration

public string? FullName { get; set; }

Property Value

Type	Description
string

Examples

Binder.BinderProps Binder.BinderProps.ClassIdent

Id

Short name of class

Declaration

public string Id { get; set; }

Property Value

Type	Description
string

Examples

BinderProps ApplyConstants(BuildSystem.ManagerObject.IDictionaryStringString) EmptyValues

Implements

List of interfaces, which current implements

Declaration

public List<string> Implements { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<><string>

Inheritance

List of class, which current inherits

Declaration

public List<string> Inheritance { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<><string>

InheritedMembers

List of methods and properties inherited from parent classes

Declaration

public List<string> InheritedMembers { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<><string>

Langs

Language of documentation

Declaration

public List<SourceInfoLang> Langs { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<><SourceInfoLang>

Name

Same value as Id, but here is name, provided to user in HTML view

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Examples

BinderProps ApplyConstants(IDictionaryStringString) EmptyValues()

NamespaceValue

Name of assembly

Declaration

public string? NamespaceValue { get; set; }

Property Value

Type	Description
string

Examples

Binder

NameWithType

Name with Parent

Declaration

public string? NameWithType { get; set; }

Property Value

Type	Description
string

Examples

BinderProps BinderProps.ClassIdent

Parent

Same value as for NamespaceValue

Declaration

public string? Parent { get; set; }

Property Value

Type	Description
string

Examples

Binder

References

List of types used in describing this type

Declaration

public List<SourceInfo> References { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<><SourceInfo>

ReferencesEmpty

List of types used in describing this type. Each reference doesn't exist in result files

Declaration

public Dictionary<string, string?> ReferencesEmpty { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<,><string, string>

SourcePath

Assembly name

Declaration

public string? SourcePath { get; set; }

Property Value

Type	Description
string

Examples

Binder

Summary

Comment

Declaration

public SourceInfoSummary? Summary { get; set; }

Property Value

Type	Description
SourceInfoSummary

Syntax

Example for writing in special language

Declaration

public SourceInfoSyntax? Syntax { get; set; }

Property Value

Type	Description
SourceInfoSyntax

Type

Type of object

Declaration

public Nullable<SourceInfoType> Type { get; set; }

Property Value

Type	Description
System.Nullable<><SourceInfoType>

Examples

Class Field

Uid

Unique name of class with full path

Declaration

public string Uid { get; set; }

Property Value

Type	Description
string

Examples

Binder.BinderProps

Methods

AddReference(SourceInfo)

Add new item if not exists in References. Comparing by uid

Declaration

public void AddReference(SourceInfo sourceInfo)

Parameters

Type	Name	Description
SourceInfo	sourceInfo