Class FileAndType

Inheritance
Object
FileAndType
Implements
Inherited Members
Namespace: Microsoft.DocAsCode.Plugins
Assembly: Microsoft.DocAsCode.Plugins.dll
Syntax
public sealed class FileAndType : IEquatable<FileAndType>

Constructors

| Improve this Doc View Source

FileAndType(String, String, DocumentType, String, String)

Declaration
[JsonConstructor]
public FileAndType(string baseDir, string file, DocumentType type, string sourceDir = null, string destinationDir = null)
Parameters
Type Name Description
String baseDir
String file
DocumentType type
String sourceDir
String destinationDir

Properties

| Improve this Doc View Source

BaseDir

Declaration
[JsonProperty("baseDir")]
public string BaseDir { get; }
Property Value
Type Description
String
| Improve this Doc View Source

DestinationDir

Declaration
[JsonProperty("destinationDir")]
public string DestinationDir { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

File

Declaration
[JsonProperty("file")]
public string File { get; }
Property Value
Type Description
String
| Improve this Doc View Source

FullPath

Declaration
[JsonIgnore]
public string FullPath { get; }
Property Value
Type Description
String
| Improve this Doc View Source

SourceDir

Declaration
[JsonProperty("sourceDir")]
public string SourceDir { get; set; }
Property Value
Type Description
String
| Improve this Doc View Source

StringComparer

Declaration
[JsonIgnore]
public StringComparer StringComparer { get; }
Property Value
Type Description
StringComparer
| Improve this Doc View Source

Type

Declaration
[JsonProperty("type")]
public DocumentType Type { get; }
Property Value
Type Description
DocumentType

Methods

| Improve this Doc View Source

ChangeBaseDir(String)

Declaration
public FileAndType ChangeBaseDir(string baseDir)
Parameters
Type Name Description
String baseDir
Returns
Type Description
FileAndType
| Improve this Doc View Source

ChangeFile(String)

Declaration
public FileAndType ChangeFile(string file)
Parameters
Type Name Description
String file
Returns
Type Description
FileAndType
| Improve this Doc View Source

ChangeType(DocumentType)

Declaration
public FileAndType ChangeType(DocumentType type)
Parameters
Type Name Description
DocumentType type
Returns
Type Description
FileAndType
| Improve this Doc View Source

Equals(FileAndType)

Declaration
public bool Equals(FileAndType other)
Parameters
Type Name Description
FileAndType other
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

Operators

| Improve this Doc View Source

Equality(FileAndType, FileAndType)

Declaration
public static bool operator ==(FileAndType left, FileAndType right)
Parameters
Type Name Description
FileAndType left
FileAndType right
Returns
Type Description
Boolean
| Improve this Doc View Source

Inequality(FileAndType, FileAndType)

Declaration
public static bool operator !=(FileAndType left, FileAndType right)
Parameters
Type Name Description
FileAndType left
FileAndType right
Returns
Type Description
Boolean

Implements

Extension Methods