DocReferenceHandlerBase

Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core Inheritance: System.Object

Syntax

CloudNimble.DotNetDocs.Core.DocReferenceHandlerBase

Summary

Base class for documentation reference handlers providing common file copying functionality.

Remarks

This abstract class contains shared logic for copying files from referenced documentation projects, including directory recursion, exclusion pattern matching, and glob pattern support. Derived classes should implement String) to provide format-specific processing such as content rewriting and resource relocation.

Constructors

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

DocumentationType Abstract

Syntax

public abstract CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType DocumentationType { get; }

Property Value

Type: CloudNimble.DotNetDocs.Core.Configuration.SupportedDocumentationType

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ProcessAsync Abstract

Syntax

public abstract System.Threading.Tasks.Task ProcessAsync(CloudNimble.DotNetDocs.Core.DocumentationReference reference, string documentationRootPath)

Parameters

Name	Type	Description
`reference`	`CloudNimble.DotNetDocs.Core.DocumentationReference`	-
`documentationRootPath`	`string`	-

Returns

Type: System.Threading.Tasks.Task

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

CloudNimble.DotNetDocs.Core.IDocReferenceHandler

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor Inherited

​Syntax

​Properties

​ DocumentationType Abstract

​Syntax

​Property Value

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ProcessAsync Abstract

​Syntax

​Parameters

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

​Related APIs

Definition

Syntax

Summary

Remarks

Constructors

.ctor Inherited

Syntax

Properties

DocumentationType Abstract

Syntax

Property Value

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ProcessAsync Abstract

Syntax

Parameters

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns

Related APIs