docs.unity3d.com
    Show / Hide Table of Contents

    Class XmlDocumentationExtractor

    Inheritance
    Object
    XmlDocumentationExtractor
    Namespace: Ludiq.Bolt
    Syntax
    public sealed class XmlDocumentationExtractor : IExtractor

    Properties

    autoCompare

    Declaration
    public bool autoCompare { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IExtractor.autoCompare

    autoLoad

    Declaration
    public bool autoLoad { get; }
    Property Value
    Type Description
    Boolean
    Implements
    IExtractor.autoLoad

    extractPriority

    Declaration
    public int extractPriority { get; }
    Property Value
    Type Description
    Int32
    Implements
    IExtractor.extractPriority

    hasStartedLoading

    Declaration
    public bool hasStartedLoading { get; set; }
    Property Value
    Type Description
    Boolean
    Implements
    IExtractor.hasStartedLoading

    label

    Declaration
    public string label { get; }
    Property Value
    Type Description
    String
    Implements
    IExtractor.label

    loadPriority

    Declaration
    public int loadPriority { get; }
    Property Value
    Type Description
    Int32
    Implements
    IExtractor.loadPriority

    path

    Declaration
    public string path { get; }
    Property Value
    Type Description
    String
    Implements
    IExtractor.path

    Methods

    Compare(ExtractionConfiguration)

    Declaration
    public int Compare(ExtractionConfiguration configuration)
    Parameters
    Type Name Description
    ExtractionConfiguration configuration
    Returns
    Type Description
    Int32
    Implements
    IExtractor.Compare(ExtractionConfiguration)

    Extract(ExtractionConfiguration)

    Declaration
    public IExtract Extract(ExtractionConfiguration configuration)
    Parameters
    Type Name Description
    ExtractionConfiguration configuration
    Returns
    Type Description
    IExtract
    Implements
    IExtractor.Extract(ExtractionConfiguration)

    Fallback()

    Declaration
    public void Fallback()
    Implements
    IExtractor.Fallback()

    GenerateUnityProjectDocumentation(String)

    Declaration
    public static string GenerateUnityProjectDocumentation(string projectPath)
    Parameters
    Type Name Description
    String projectPath
    Returns
    Type Description
    String

    GetAssemblyDocumentationPath(Assembly)

    Declaration
    public static string GetAssemblyDocumentationPath(Assembly assembly)
    Parameters
    Type Name Description
    Assembly assembly
    Returns
    Type Description
    String

    Load(XmlDocumentationExtract)

    Declaration
    public void Load(XmlDocumentationExtract extract)
    Parameters
    Type Name Description
    XmlDocumentationExtract extract

    ReadExtract(Stream)

    Declaration
    public IExtract ReadExtract(Stream stream)
    Parameters
    Type Name Description
    Stream stream
    Returns
    Type Description
    IExtract
    Implements
    IExtractor.ReadExtract(Stream)

    SyncUnitySolution()

    Declaration
    public static void SyncUnitySolution()

    WriteExtract(IExtract, Stream)

    Declaration
    public void WriteExtract(IExtract extract, Stream stream)
    Parameters
    Type Name Description
    IExtract extract
    Stream stream
    Implements
    IExtractor.WriteExtract(IExtract, Stream)

    Explicit Interface Implementations

    IExtractor.Load(IExtract)

    Declaration
    void IExtractor.Load(IExtract extract)
    Parameters
    Type Name Description
    IExtract extract
    Implements
    IExtractor.Load(IExtract)

    Extension Methods

    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    LiteralUtility.ToLiteralString(Object)
    LiteralUtility.ToLiteralStringOrDefault(Object)
    LiteralUtility.TryToLiteralString(Object, out String)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone(Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy(Object)
    Cloning.CloneViaSerializationPolicy(Object, out Dictionary<Object, Object>)
    Cloning.CloneViaSerializationPolicy<T>(T)
    Cloning.CloneViaSerializationPolicy<T>(T, out Dictionary<Object, Object>)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean)
    Cloning.CloneInto(Object, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean)
    Cloning.CloneInto<T>(T, ref Object, ICloner, Boolean, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object)
    Cloning.CloneIntoViaSerializationPolicy(Object, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object)
    Cloning.CloneIntoViaSerializationPolicy<T>(T, ref Object, out Dictionary<Object, Object>)
    Cloning.CloneValueType(Object)
    ConversionUtility.ConvertTo<TSource>(TSource, Type)
    ConversionUtility.IsLateConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsLateConvertibleTo<T>(Object, Boolean)
    ConversionUtility.LateConvertTo(Object, Type)
    ConversionUtility.LateConvertTo<T>(Object)
    ConversionUtility.TryLateConvertTo(Object, Type, out Object, Boolean)
    ConversionUtility.TryLateConvertTo<T>(Object, out T, Boolean)
    TypeUtility.ToShortString(Object, Int32)
    TypeUtility.CastTo<T>(Object)
    Serialization.FullSerialize(Object, Boolean)
    Serialization.OdinSerialize<T>(T, DataFormat)
    Serialization.OdinSerialize<T>(T, ref SerializationData, DataFormat)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.UnityNullCoalesce(Object, Object)
    UnityObjectUtility.ToSafeString(Object)
    XFilterProvider.Filter(Object)
    XFilterProvider.Filter<TFilter>(Object)
    BoltGenerationUtility.GenerateLiteral(Object, IGeneration)
    XGeneratorProvider.Generator(Object, IGeneration)
    XGeneratorProvider.Generator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.HasGenerator(Object, IGeneration)
    XGeneratorProvider.HasGenerator<TGenerator>(Object, IGeneration)
    XGeneratorProvider.TryGetGenerator(Object, out IGenerator, IGeneration)
    XGeneratorProvider.TryGetGenerator<TGenerator>(Object, IGeneration, out TGenerator)
    HybridConversionUtility.ConvertTo(Object, HybridType, HybridType)
    HybridConversionUtility.IsLateConvertibleTo(Object, HybridType, Boolean)
    HybridConversionUtility.LateConvertTo(Object, HybridType)
    HybridConversionUtility.TryLateConvertTo(Object, HybridType, out Object, Boolean)
    HybridTypeUtility.GetHybridType(Object)
    IsUtility.Is<TO, TC>(TO, out TC)
    PrivateReflectionUsingDynamicExtensions.AsDynamic(Object)
    JsonWriter.ToJson(Object)
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023