Skip to main content

​
Definition

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

​
Syntax

CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions

​
Summary

Provides configuration options for how documentation files are named and organized.

​
Remarks

This class controls the file naming strategy for rendered documentation, including how namespaces are represented in the file system and what characters are used as separators in file names.

​
Constructors

​
.ctor

Initializes a new instance of the FileNamingOptions class with default settings.

​
Syntax

public FileNamingOptions()

​
.ctor

Initializes a new instance of the FileNamingOptions class with the specified settings.

​
Syntax

public FileNamingOptions(CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode namespaceMode, char namespaceSeparator = '-')

​
Parameters

NameTypeDescription
namespaceModeCloudNimble.DotNetDocs.Core.Configuration.NamespaceModeThe namespace organization mode.
namespaceSeparatorcharThe character to use as a namespace separator in file names.

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
NamespaceMode

Gets or sets the mode for organizing namespace documentation.

​
Syntax

public CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode NamespaceMode { get; set; }

​
Property Value

Type: CloudNimble.DotNetDocs.Core.Configuration.NamespaceMode The namespace organization mode. Default is NamespaceMode.File.

​
Remarks

This property determines whether namespaces are rendered as individual files or organized into a folder hierarchy.

​
NamespaceSeparator

Gets or sets the character used to separate namespace parts in file names.

​
Syntax

public char NamespaceSeparator { get; set; }

​
Property Value

Type: char The separator character. Default is ’-’.

​
Remarks

This setting is only used when FileNamingOptions.NamespaceMode is set to NamespaceMode.File. When using NamespaceMode.Folder, this setting is ignored as namespaces are organized into actual folder hierarchies. Common values include ’-’ (hyphen), ’_’ (underscore), or ’.’ (period).

​
Methods

​
Clone

Creates a copy of the current FileNamingOptions instance.

​
Syntax

public CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions Clone()

​
Returns

Type: CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions A new instance with the same settings.

​
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

​
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

​
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?