Slnx.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Slnx</name>
    </assembly>
    <members>
        <member name="T:Slnx.DescendantConfiguration">
            <summary>
            Represents a "&lt;Configuration&gt;" like tag.
            </summary>
        </member>
        <member name="P:Slnx.DescendantConfiguration.Solution">
            <summary>
            Solution where this configuration applies to.
            </summary>
        </member>
        <member name="P:Slnx.DescendantConfiguration.Project">
            <summary>
            Project where this configuration applies to.
            </summary>
        </member>
        <member name="M:Slnx.DescendantConfiguration.#ctor(System.String,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.DescendantConfiguration" /> class.
            </summary>
            <param name="solution">Solution where this configuration applies to.</param>
            <param name="project">Project where this configuration applies to.</param>
        </member>
        <member name="T:Slnx.Folder">
            <summary>
            Represents a folder in the same level as the solution.
            </summary>
        </member>
        <member name="P:Slnx.Folder.Empty">
            <summary>
            Gets an instance of <see cref="T:Slnx.Folder" /> with no content and name "(Folder Name)".
            </summary>
        </member>
        <member name="P:Slnx.Folder.Name">
            <summary>
            Name of the folder.
            </summary>
        </member>
        <member name="P:Slnx.Folder.DescendantProjects">
            <summary>
            Nested projects in the folder. If this is <see langword="NULL"/>, then there
            are no descendant projects.
            </summary>
        </member>
        <member name="P:Slnx.Folder.DescendantFolders">
            <summary>
            Nested folders in the folder. If this is <see langword="NULL"/>, then there
            are no descendant folders.
            </summary>
        </member>
        <member name="P:Slnx.Folder.DescendantFiles">
            <summary>
            Files in the folder. If this is <see langword="NULL"/>, then there
            are no descendant files.
            </summary>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String,Slnx.Project[],Slnx.Folder[],System.String[])">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder" /> class.
            </summary>
            <param name="name">Folder name.</param>
            <param name="projects">All projects.</param>
            <param name="folders">All folders.</param>
            <param name="files">All files.</param>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder"/> class.
            </summary>
            <param name="name">The name of the folder.</param>
            <remarks>
            Properties <see cref="P:Slnx.Folder.DescendantProjects"/>, <see cref="P:Slnx.Folder.DescendantFiles"/>,
            and <see cref="P:Slnx.Folder.DescendantFolders"/> will be <see langword="null"/>.
            </remarks>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String,Slnx.Project[])">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder"/> class.
            </summary>
            <param name="name">The name of the folder.</param>
            <param name="projects">All projects.</param>
            <remarks>
            Properties <see cref="P:Slnx.Folder.DescendantFiles"/> and <see cref="P:Slnx.Folder.DescendantFolders"/>
            will be <see langword="null"/>.
            </remarks>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String,Slnx.Folder[])">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder"/> class.
            </summary>
            <param name="name">The name of the folder.</param>
            <param name="folders">All folders.</param>
            <remarks>
            Properties <see cref="P:Slnx.Folder.DescendantFiles"/> and <see cref="P:Slnx.Folder.DescendantProjects"/>
            will be <see langword="null"/>.
            </remarks>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String,System.String[])">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder"/> class.
            </summary>
            <param name="name">The name of the folder.</param>
            <param name="files">All files.</param>
            <remarks>
            Properties <see cref="P:Slnx.Folder.DescendantProjects"/> and <see cref="P:Slnx.Folder.DescendantFolders"/>
            will be <see langword="null"/>.
            </remarks>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String,Slnx.Folder[],System.String[])">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder"/> class.
            </summary>
            <param name="name">The name of the folder.</param>
            <param name="folders">All folders.</param>
            <param name="files">All files.</param>
            <remarks>
            Property <see cref="P:Slnx.Folder.DescendantProjects"/> will be <see langword="null"/>.
            </remarks>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String,Slnx.Folder[],Slnx.Project[])">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder"/> class.
            </summary>
            <param name="name">The name of the folder.</param>
            <param name="folders">All folders.</param>
            <param name="projects">All projects.</param>
            <remarks>
            Property <see cref="P:Slnx.Folder.DescendantFiles"/> will be <see langword="null"/>.
            </remarks>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String,Slnx.Project[],System.String[])">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder"/> class.
            </summary>
            <param name="name">The name of the folder.</param>
            <param name="project">All projects.</param>
            <param name="files">All files.</param>
            <remarks>
            Property <see cref="P:Slnx.Folder.DescendantFolders"/> will be <see langword="null"/>.
            </remarks>
        </member>
        <member name="M:Slnx.Folder.#ctor(System.String,Slnx.Project[],Slnx.Folder[])">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Folder"/> class.
            </summary>
            <param name="name">The name of the folder.</param>
            <param name="project">All projects.</param>
            <param name="folders">All folders.</param>
            <remarks>
            Property <see cref="P:Slnx.Folder.DescendantFiles"/> will be <see langword="null"/>.
            </remarks>
        </member>
        <member name="M:Slnx.Folder.AddProjects(Slnx.Project[])">
            <summary>
            Adds a given array of projects to this instance of <see cref="T:Slnx.Folder"/>.
            </summary>
            <param name="projects">An array of projects to add.</param>
            <returns>Current instance of <see cref="T:Slnx.Folder"/> after adding the given projects.</returns>
        </member>
        <member name="M:Slnx.Folder.AddProject(Slnx.Project)">
            <summary>
            Adds a single project to this instance of <see cref="T:Slnx.Folder"/>.
            </summary>
            <param name="project">A project that will be added.</param>
            <returns>Current instance of <see cref="T:Slnx.Folder"/> after adding the given project.</returns>
        </member>
        <member name="M:Slnx.Folder.AddFiles(System.String[])">
            <summary>
            Adds a given array of files to this instance of <see cref="T:Slnx.Folder"/>.
            </summary>
            <param name="files">An array of files to add.</param>
            <returns>Current instance of <see cref="T:Slnx.Folder"/> after adding the given files.</returns>
        </member>
        <member name="M:Slnx.Folder.AddFile(System.String)">
            <summary>
            Adds a single file to this instance of <see cref="T:Slnx.Folder"/>.
            </summary>
            <param name="file">A file that will be added.</param>
            <returns>Current instance of <see cref="T:Slnx.Folder"/> after adding the given file.</returns>
        </member>
        <member name="M:Slnx.Folder.AddFolders(Slnx.Folder[])">
            <summary>
            Adds a given array of folders to this instance of <see cref="T:Slnx.Folder"/>.
            </summary>
            <param name="folders">An array of folders to add.</param>
            <returns>Current instance of <see cref="T:Slnx.Folder"/> after adding the given folder.</returns>
        </member>
        <member name="M:Slnx.Folder.AddFolder(Slnx.Folder)">
            <summary>
            Adds a single folder to this instance of <see cref="T:Slnx.Folder"/>.
            </summary>
            <param name="folder">A folder that will be added.</param>
            <returns>Current instance of <see cref="T:Slnx.Folder"/> after adding the given folder.</returns>
        </member>
        <member name="M:Slnx.Folder.AddProjectWithPathOnly(System.String)">
            <summary>
            Adds a new project without any configuration to this instance of <see cref="T:Slnx.Folder"/>
            </summary>
            <param name="path">The path to the project.</param>
            <returns>
            A tuple that contains two elements:
            <list type="bullet">
              <item>
                <em>Item 1</em> (<see cref="T:Slnx.Folder"/>): Current instance of
                <see cref="T:Slnx.Folder"/> after adding the project.
              </item>
              <item>
                <em>Item 2</em> (<see cref="T:Slnx.Project"/>): The project that was added.
              </item>
            </list>
            </returns>
        </member>
        <member name="T:Slnx.Project">
            <summary>
            Represents a single project found in the SLNX file.
            </summary>
        </member>
        <member name="P:Slnx.Project.Exists">
            <summary>
            Checks if the project file exists.
            </summary>
        </member>
        <member name="P:Slnx.Project.Path">
            <summary>
            Path to the project file.
            </summary>
        </member>
        <member name="P:Slnx.Project.Type">
            <summary>
            Type of the project.
            </summary>
        </member>
        <member name="P:Slnx.Project.Extension">
            <summary>
            Extension of the project file. If the extension isn't present, the
            value is null.
            </summary>
        </member>
        <member name="P:Slnx.Project.HasExtension">
            <summary>
            Checks if the <see cref="P:Slnx.Project.Extension" /> property has an extension.
            </summary> 
        </member>
        <member name="P:Slnx.Project.ProjectType">
            <summary>
            Gets the type of the project. This can be a string (for example, a string "Classic C#"),
            or a GUID.
            </summary>
        </member>
        <member name="P:Slnx.Project.Configuration">
            <summary>
            Descendant configuration.
            </summary>
        </member>
        <member name="M:Slnx.Project.#ctor(System.String,System.String,Slnx.DescendantConfiguration)">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Project" /> class.
            </summary>
            <param name="path">Path to the project file.</param>
            <param name="type">The project type.</param>
            <param name="config">The configuration.</param>
        </member>
        <member name="M:Slnx.Project.WithConfiguration(Slnx.DescendantConfiguration)">
            <summary>
            Changes the descendant configuration of this project to <paramref name="configuration"/> and returns it.
            </summary>
            <param name="configuration">The descendant project configuration.</param>
            <returns>Current instance of <see cref="T:Slnx.Project"/> with the given configuration.</returns>
        </member>
        <member name="T:Slnx.ProjectType">
            <summary>
            Represents the type of a project file.
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.CSharp">
            <summary>
            C# Project (*.csproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.VC">
            <summary>
            Visual C++ Project (*.vcxproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.VisualBasic">
            <summary>
            VB.NET Project (*.vbproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.FSharp">
            <summary>
            F# Project (*.fsproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.Installer">
            <summary>
            Microsoft Installer Project (*.vdproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.Shared">
            <summary>
            Shared Project (*.shproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.Database">
            <summary>
            Database Project (*.dbproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.DockerCompose">
            <summary>
            Docker Compose Project (*.dcproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.Sql">
            <summary>
            SQL Project (*.sqlproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.JavaScript">
            <summary>
            JavaScript Application/ECMAScript Project (*.esproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.NetCore2015">
            <summary>
            .NET Core 2015 Project (*.xproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.Common">
            <summary>
            Common MSBuild Project (*.msbuildproj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.Project">
            <summary>
            Project (*.proj)
            </summary>
        </member>
        <member name="F:Slnx.ProjectType.Unknown">
            <summary>
            Any project type which is not defined.
            </summary>
        </member>
        <member name="T:Slnx.ProjectTypeExtensions">
            <summary>
            Extension methods for <see cref="T:Slnx.ProjectType" />.
            </summary>
        </member>
        <member name="M:Slnx.ProjectTypeExtensions.GetExtension(Slnx.ProjectType)">
            <summary>
            Returns the extension for the project type.
            </summary>
            <param name="projectType">Type of the project.</param>
            <returns>A file extension for that project type, excluding the period.</returns>
        </member>
        <member name="M:Slnx.ProjectTypeExtensions.FromExtension(System.String)">
            <summary>
            Returns the project type for the project extension.
            </summary>
            <param name="extension">Extension of the project, excluding the period.</param>
            <returns>A type of the project from the extension.</returns>
        </member>
        <member name="T:Slnx.Property">
            <summary>
            Represents a &lt;Property&gt; element.
            </summary>
        </member>
        <member name="P:Slnx.Property.Name">
            <summary>
            Name of the property.
            </summary>
        </member>
        <member name="P:Slnx.Property.Value">
            <summary>
            Property value.
            </summary>
        </member>
        <member name="M:Slnx.Property.#ctor(System.String,System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.Property"/> class.
            </summary>
            <param name="name">Name of the property.</param>
            <param name="value">Property value.</param>
        </member>
        <member name="P:Slnx.Property.IsMSBuildSharedItemsImports">
            <summary>
            Checks if the name of the property signifies an MSBuild Shared Items import.
            </summary>
            <remarks>
            Example:
            <code>
              Path\To\ProjItems\File.projitems*{AnyGuidHere}*SharedItemsImports
            </code>
            </remarks>
        </member>
        <member name="T:Slnx.PropertyCollection">
            <summary>
            Represents the &lt;Properties&gt; element.
            </summary>
        </member>
        <member name="P:Slnx.PropertyCollection.Name">
            <summary>
            Name of the property collection (if present). Example: <c>SharedMSBuildProjectFiles</c>.
            </summary>
        </member>
        <member name="P:Slnx.PropertyCollection.Scope">
            <summary>
            Scope of the property collection (if present). Example: <c>PreLoad</c>.
            </summary>
        </member>
        <member name="P:Slnx.PropertyCollection.Properties">
            <summary>
            All descendant properties.
            </summary>
        </member>
        <member name="M:Slnx.PropertyCollection.#ctor(System.String,System.String,System.Collections.Generic.List{Slnx.Property})">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.PropertyCollection"/>.
            </summary>
            <param name="name">Name of the property collection (if present).</param>
            <param name="scope">Scope of the property collection (if present).</param>
            <param name="properties">All descendant properties.</param>
        </member>
        <member name="T:Slnx.SlnxFactory">
            <summary>
            Builds an SLNX file.
            </summary>
        </member>
        <member name="P:Slnx.SlnxFactory.Folders">
            <summary>
            All folders.
            </summary>
        </member>
        <member name="P:Slnx.SlnxFactory.Projects">
            <summary>
            All projects.
            </summary>
        </member>
        <member name="P:Slnx.SlnxFactory.Properties">
            <summary>
            All &lt;Properties&gt; elements.
            </summary>
        </member>
        <member name="M:Slnx.SlnxFactory.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.SlnxFactory" /> class.
            </summary>
        </member>
        <member name="M:Slnx.SlnxFactory.AsModel">
            <summary>
            Converts this instance of <see cref="T:Slnx.SlnxFactory" /> into <see cref="T:Slnx.SlnxModel" />.
            </summary>
            <returns>An instance of <see cref="T:Slnx.SlnxModel" />.</returns>
        </member>
        <member name="M:Slnx.SlnxFactory.AddFolder(Slnx.Folder)">
            <summary>
            Adds a new folder to the SLNX file.
            </summary>
            <param name="folder">The folder to add.</param>
            <returns>Current instance of <see cref="T:Slnx.SlnxFactory"/> after adding a folder.</returns>
            <remarks>
              This will also return a copy of the current instance, which could introduce additional
              memory allocation.
            </remarks>
        </member>
        <member name="M:Slnx.SlnxFactory.AddProjectWithPathOnly(System.String)">
            <summary>
            Adds a new project to the SLNX file.
            </summary>
            <param name="path">The project to add.</param>
            <returns>Current instance of <see cref="T:Slnx.SlnxFactory"/> after adding a project.</returns>
            <remarks>
              This will also return a copy of the current instance, which could introduce additional
              memory allocation.
            </remarks>
        </member>
        <member name="T:Slnx.SlnxModel">
            <summary>
            Represents information about an SLNX file.
            </summary>
        </member>
        <member name="F:Slnx.SlnxModel.DefaultXmlSettings">
            <summary>
            If you pass <see langword="null"/> to <see cref="M:Slnx.SlnxModel.Store(System.Xml.XmlWriterSettings)"/>, this is
            the <see cref="T:System.Xml.XmlWriterSettings"/> instance that <see cref="N:Slnx"/> will use.
            </summary>
        </member>
        <member name="P:Slnx.SlnxModel.TopLevelProjects">
            <summary>
            Gets all projects in the same level as the SLNX.
            </summary>
        </member>
        <member name="P:Slnx.SlnxModel.TopLevelFolders">
            <summary>
            Gets all folders in the same level as the SLNX.
            </summary>
        </member>
        <member name="P:Slnx.SlnxModel.PropertyCollections">
            <summary>
            Gets all property collections in the same level as the SLNX. These can only appear
            in the same level as the SLNX - they cannot appear inside folder or project elements.
            </summary>
        </member>
        <member name="M:Slnx.SlnxModel.#ctor(System.Collections.Generic.List{Slnx.Project},System.Collections.Generic.List{Slnx.Folder},System.Collections.Generic.List{Slnx.PropertyCollection})">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.SlnxModel" /> class.
            </summary>
            <param name="projects">A list of projects.</param>
            <param name="folders">A list of folders.</param>
            <param name="propertyCollections">A list of property collections.</param>
        </member>
        <member name="M:Slnx.SlnxModel.Load(System.String)">
            <summary>
            Loads and parses a SLNX file.
            </summary>
            <param name="slnxContent">The string contents of the SLNX file. Use <see cref="M:System.IO.File.ReadAllText(System.String)" />.</param>
            <returns>Information about that SLNX file.</returns>
        </member>
        <member name="M:Slnx.SlnxModel.Store(System.String,System.Xml.XmlWriterSettings)">
            <summary>
            Stores the data of this instance of <see cref="T:Slnx.SlnxModel" /> into a SLNX file.
            </summary>
            <param name="outputFile">
            Output file. Can be anything but it is recommended for the
            extension to end with .slnx.
            </param>
            <param name="settings">Settings for the style of the output XML. If the value is <see langword="null" />, default parameters are used.</param>
            <remarks>
            The output file will be attempted to be deleted if it exists.
            </remarks>
        </member>
        <member name="M:Slnx.SlnxModel.Store(System.Xml.XmlWriterSettings)">
            <summary>
            Converts this instance of <see cref="T:Slnx.SlnxModel"/> to the string representation
            of the SLNX file with same projects and folders.
            </summary>
            <param name="xmlWriterSettings">Settings for the style of the output XML. If the value is <see langword="null" />, default parameters are used.</param>
            <returns>A string that represents the SLNX file with projects, folders, and other metadata from this instance of <see cref="T:Slnx.SlnxModel"/>.</returns>
        </member>
        <member name="M:Slnx.SlnxModel.StoreAsync(System.String,System.Xml.XmlWriterSettings)">
            <summary>
            Stores the data of this instance of <see cref="T:Slnx.SlnxModel" /> into a SLNX file.
            </summary>
            <param name="outputFile">
            Output file. Can be anything but it is recommended for the
            extension to end with .slnx.
            </param>
            <param name="settings">Settings for the style of the output XML. If the value is <see langword="null" />, default parameters are used.</param>
            <remarks>
            The output file will be attempted to be deleted if it exists.
            </remarks>
        </member>
        <member name="M:Slnx.SlnxModel.StoreAsync(System.Xml.XmlWriterSettings)">
            <summary>
            Converts this instance of <see cref="T:Slnx.SlnxModel"/> to the string representation
            of the SLNX file with same projects and folders.
            </summary>
            <param name="xmlWriterSettings">Settings for the style of the output XML. If the value is <see langword="null" />, default parameters are used.</param>
            <returns>A string that represents the SLNX file with projects, folders, and other metadata from this instance of <see cref="T:Slnx.SlnxModel"/>.</returns>
        </member>
        <member name="T:Slnx.SolutionException">
            <summary>
            Represents an error related to SLNX syntax or its infrastructure.
            </summary>
        </member>
        <member name="M:Slnx.SolutionException.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.SolutionException" /> class.
            </summary> 
            <param name="message">Exception message.</param>
        </member>
        <member name="M:Slnx.SolutionException.#ctor(System.String,System.Exception)">
            <summary>
            Initializes a new instance of the <see cref="T:Slnx.SolutionException" /> class.
            </summary> 
            <param name="message">Exception message.</param>
            <param name="innerException">An inner exception.</param>
        </member>
    </members>
</doc>