Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core.Configuration Inheritance: System.ObjectSyntax
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
.ctor
Initializes a new instance of the FileNamingOptions class with the specified settings.Syntax
Parameters
.ctor Inherited
Inherited from
objectSyntax
Properties
NamespaceMode
Gets or sets the mode for organizing namespace documentation.Syntax
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
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
Returns
Type:CloudNimble.DotNetDocs.Core.Configuration.FileNamingOptions
A new instance with the same settings.
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?