Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TopicMetadata

Represents the metadata for a DocFX topic.

Hierarchy

  • TopicMetadata

Index

Properties

Properties

Optional detailedType

detailedType: TopicType.Conceptual | TopicType.Namespace | TopicType.Type | TopicType.Property | TopicType.Method | TopicType.PowerShellCmdlet

The topic's detailed sub-type.

Optional memberType

memberType: string

The member type (for managed reference topics).

Optional name

name: string

The topic name.

sourceFile

sourceFile: string

The source file where the topic is defined.

Optional title

title: string

The topic title.

type

type: string

The topic type.

uid

uid: string

The topic UID.

Generated using TypeDoc