DocFxApiItem

Represents an API item in DocFX metadata.

Syntax

public class DocFxApiItem

Inheritance

Properties

AssemblyName

public string AssemblyName { get; set; }
Gets or sets the assembly name.

Returns

string

Children

public List<string> Children { get; set; }
Gets or sets the children UIDs for this item.

Returns

List<string>

DerivedClasses

public List<string> DerivedClasses { get; set; }
Gets or sets the derived types.

Returns

List<string>

Example

public string Example { get; set; }
Gets or sets the example documentation.

Returns

string

Exceptions

public List<DocFxException> Exceptions { get; set; }
Gets or sets the list of exceptions that can be thrown.

Returns

List<DocFxException>

FullName

public string FullName { get; set; }
Gets or sets the full name including namespace.

Returns

string

Id

public string Id { get; set; }
Gets or sets the ID of this API item.

Returns

string

Implements

public List<string> Implements { get; set; }
Gets or sets the implemented interfaces.

Returns

List<string>

Inheritance

public List<string> Inheritance { get; set; }
Gets or sets the inheritance hierarchy.

Returns

List<string>

Name

public string Name { get; set; }
Gets or sets the name of this API item.

Returns

string

Namespace

public string Namespace { get; set; }
Gets or sets the namespace.

Returns

string

NameWithType

public string NameWithType { get; set; }
Gets or sets the name with type information.

Returns

string

Overload

public string Overload { get; set; }
Gets or sets the overload reference.

Returns

string

Overridden

public string Overridden { get; set; }
Gets or sets the overridden member reference.

Returns

string

Parent

public string Parent { get; set; }
Gets or sets the parent UID for this item.

Returns

string

Remarks

public string Remarks { get; set; }
Gets or sets the remarks documentation.

Returns

string

SeeAlso

public List<string> SeeAlso { get; set; }
Gets or sets the see also references.

Returns

List<string>

Source

public DocFxSource Source { get; set; }
Gets or sets the source information.

Returns

DocFxSource

Summary

public string Summary { get; set; }
Gets or sets the summary documentation.

Returns

string

Syntax

public DocFxSyntax Syntax { get; set; }
Gets or sets the syntax information for this API item.

Returns

DocFxSyntax

Type

public string Type { get; set; }
Gets or sets the type of this API item (Type, Method, Property, etc.).

Returns

string

TypeParameters

public List<DocFxTypeParameter> TypeParameters { get; set; }
Gets or sets the type parameters for generic types.

Returns

List<DocFxTypeParameter>

Uid

public string Uid { get; set; }
Gets or sets the unique identifier for this API item.

Returns

string

Remarks

This class models the structure of API items as generated by DocFX, including types, members, and their associated documentation.