Skip to main content

​
Definition

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

​
Syntax

CloudNimble.DotNetDocs.Core.Renderers.RendererBase

​
Summary

Base class for documentation renderers providing common functionality.

​
Constructors

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Enabled

When more than one Renderer is registered, allows a renderer to be turned off.

​
Syntax

public bool Enabled { get; set; }

​
Property Value

Type: bool

​
Methods

​
Equals Inherited Virtual

Inherited from object

​
Syntax

public virtual bool Equals(object obj)

​
Parameters

NameTypeDescription
objobject?-

​
Returns

Type: bool

​
Equals Inherited

Inherited from object

​
Syntax

public static bool Equals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
GetHashCode Inherited Virtual

Inherited from object

​
Syntax

public virtual int GetHashCode()

​
Returns

Type: int

​
GetNamespaceFileName

Gets a safe file name for a namespace, suitable for use in file systems.

​
Syntax

public string GetNamespaceFileName(CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension)

​
Parameters

NameTypeDescription
nsCloudNimble.DotNetDocs.Core.DocNamespaceThe namespace to get the file name for.
extensionstringThe file extension (without the dot).

​
Returns

Type: string A safe file name for the namespace.

​
Remarks

This method is deprecated. Use GetNamespaceFilePath instead.

​
GetSafeNamespaceName

Gets a safe namespace name for use in file names and display.

​
Syntax

public string GetSafeNamespaceName(CloudNimble.DotNetDocs.Core.DocNamespace ns)

​
Parameters

NameTypeDescription
nsCloudNimble.DotNetDocs.Core.DocNamespaceThe namespace to get the name for.

​
Returns

Type: string A safe namespace name, using “global” for the global namespace.

​
GetType Inherited

Inherited from object

​
Syntax

public System.Type GetType()

​
Returns

Type: System.Type

​
GetTypeFileName

Gets a safe file name for a type, suitable for use in file systems.

​
Syntax

public string GetTypeFileName(CloudNimble.DotNetDocs.Core.DocType type, CloudNimble.DotNetDocs.Core.DocNamespace ns, string extension)

​
Parameters

NameTypeDescription
typeCloudNimble.DotNetDocs.Core.DocTypeThe type to get the file name for.
nsCloudNimble.DotNetDocs.Core.DocNamespaceThe namespace containing the type.
extensionstringThe file extension (without the dot).

​
Returns

Type: string A safe file name for the type.

​
Remarks

This method is deprecated. Use GetTypeFilePath instead.

​
MemberwiseClone Inherited

Inherited from object

​
Syntax

protected internal object MemberwiseClone()

​
Returns

Type: object

​
ReferenceEquals Inherited

Inherited from object

​
Syntax

public static bool ReferenceEquals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?