Show / Hide Table of Contents

    Class FileAndType

    Inheritance
    Object
    FileAndType
    Inherited Members
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace:Microsoft.DocAsCode.Plugins
    Assembly:Microsoft.DocAsCode.Plugins.dll
    Syntax
    public sealed class FileAndType : IEquatable<FileAndType>

    Constructors

    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

    BaseDir

    Declaration
    [JsonProperty("baseDir")]
    public string BaseDir { get; }
    Property Value
    Type Description
    String

    DestinationDir

    Declaration
    [JsonProperty("destinationDir")]
    public string DestinationDir { get; set; }
    Property Value
    Type Description
    String

    File

    Declaration
    [JsonProperty("file")]
    public string File { get; }
    Property Value
    Type Description
    String

    FullPath

    Declaration
    [JsonIgnore]
    public string FullPath { get; }
    Property Value
    Type Description
    String

    SourceDir

    Declaration
    [JsonProperty("sourceDir")]
    public string SourceDir { get; set; }
    Property Value
    Type Description
    String

    StringComparer

    Declaration
    [JsonIgnore]
    public StringComparer StringComparer { get; }
    Property Value
    Type Description
    StringComparer

    Type

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

    Methods

    ChangeBaseDir(String)

    Declaration
    public FileAndType ChangeBaseDir(string baseDir)
    Parameters
    Type Name Description
    String baseDir
    Returns
    Type Description
    FileAndType

    ChangeFile(String)

    Declaration
    public FileAndType ChangeFile(string file)
    Parameters
    Type Name Description
    String file
    Returns
    Type Description
    FileAndType

    ChangeType(DocumentType)

    Declaration
    public FileAndType ChangeType(DocumentType type)
    Parameters
    Type Name Description
    DocumentType type
    Returns
    Type Description
    FileAndType

    Equals(FileAndType)

    Declaration
    public bool Equals(FileAndType other)
    Parameters
    Type Name Description
    FileAndType other
    Returns
    Type Description
    Boolean
    Implements
    IEquatable<T>.Equals(T)

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    Object.Equals(Object)

    GetHashCode()

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

    Operators

    Equality(FileAndType, FileAndType)

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

    Inequality(FileAndType, FileAndType)

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

    Extension Methods

    JsonUtility.ToJsonString(Object, Formatting, JsonSerializer)
    Back to top Copyright © 2015-2017 Microsoft
    Generated by DocFX