PublicApiSymbolIdentity Class

Namespace: Meziantou.Framework.PublicApiGenerator
Assembly: Meziantou.Framework.PublicApiGenerator.dll
Package: Meziantou.Framework.PublicApiGenerator 2.0.16
Source: PublicApiSymbolIdentity.cs
Available in package assets: net10.0net11.0

Identifies a symbol across assemblies. The documentation ID alone is not unique: unrelated assemblies, or the builds of the same assembly for several target frameworks, can declare symbols with the same documentation ID.

public sealed class PublicApiSymbolIdentity : IEquatable<PublicApiSymbolIdentity>

Implements

IEquatable<PublicApiSymbolIdentity>

Constructors

Name	Description
PublicApiSymbolIdentity(string, string)	Identifies a symbol across assemblies. The documentation ID alone is not unique: unrelated assemblies, or the builds of the same assembly for several target frameworks, can declare symbols with the same documentation ID.

PublicApiSymbolIdentity(string, string)

PublicApiSymbolIdentity.cs

public PublicApiSymbolIdentity(string Scope, string DocumentationId)

Parameters

Scope string: The scope of the symbol. See PublicApiAssembly.Scope.
DocumentationId string: The XML documentation ID of the symbol.

Properties

Name	Description
DocumentationId	The XML documentation ID of the symbol.
Scope	The scope of the symbol. See `PublicApiAssembly.Scope`.

DocumentationId

PublicApiSymbolIdentity.cs

The XML documentation ID of the symbol.

public string DocumentationId { get; init; }

Property value

string

Scope

PublicApiSymbolIdentity.cs

The scope of the symbol. See PublicApiAssembly.Scope.

public string Scope { get; init; }

Property value

string

Methods

Name	Description
Deconstruct(string, string)
Equals(PublicApiSymbolIdentity?)
Equals(object?)
GetHashCode()
ToString()

Deconstruct(string, string)

public void Deconstruct(out string Scope, out string DocumentationId)

Parameters

Scope string
DocumentationId string

No documentation is available.

Equals overloads

Equals(PublicApiSymbolIdentity?)

public bool Equals(PublicApiSymbolIdentity? other)

Parameters

other PublicApiSymbolIdentity?

Returns

bool

No documentation is available.

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

No documentation is available.

GetHashCode()

public override int GetHashCode()

Returns

int

No documentation is available.

ToString()

PublicApiSymbolIdentity.cs

public override string ToString()

Returns

string

No documentation is available.

Operators

Name	Description
operator ==(PublicApiSymbolIdentity?, PublicApiSymbolIdentity?)
operator !=(PublicApiSymbolIdentity?, PublicApiSymbolIdentity?)

operator ==(PublicApiSymbolIdentity?, PublicApiSymbolIdentity?)

public static bool operator ==(PublicApiSymbolIdentity? left, PublicApiSymbolIdentity? right)

Parameters

left PublicApiSymbolIdentity?
right PublicApiSymbolIdentity?

Returns

bool

No documentation is available.

operator !=(PublicApiSymbolIdentity?, PublicApiSymbolIdentity?)

public static bool operator !=(PublicApiSymbolIdentity? left, PublicApiSymbolIdentity? right)

Parameters

left PublicApiSymbolIdentity?
right PublicApiSymbolIdentity?

Returns

bool

No documentation is available.