From 80df808461fca91b53e232b5b504a5c868029697 Mon Sep 17 00:00:00 2001 From: Sean Hall Date: Sat, 19 Dec 2020 19:15:11 -0600 Subject: Enable XML doc. --- .../BootstrapperApplicationData.cs | 38 ++++++++++++++++++++++ 1 file changed, 38 insertions(+) (limited to 'src/WixToolset.Mba.Core/BootstrapperApplicationData.cs') diff --git a/src/WixToolset.Mba.Core/BootstrapperApplicationData.cs b/src/WixToolset.Mba.Core/BootstrapperApplicationData.cs index 05672f1b..739a08bb 100644 --- a/src/WixToolset.Mba.Core/BootstrapperApplicationData.cs +++ b/src/WixToolset.Mba.Core/BootstrapperApplicationData.cs @@ -6,12 +6,29 @@ namespace WixToolset.Mba.Core using System.IO; using System.Xml.XPath; + /// + /// Utility class for reading BootstrapperApplicationData.xml. + /// public class BootstrapperApplicationData : IBootstrapperApplicationData { + /// + /// + /// public const string DefaultFileName = "BootstrapperApplicationData.xml"; + + /// + /// + /// public const string XMLNamespace = "http://wixtoolset.org/schemas/v4/BootstrapperApplicationData"; + /// + /// The default path of where the BA was extracted to. + /// public static readonly DirectoryInfo DefaultFolder; + + /// + /// The default path to BootstrapperApplicationData.xml. + /// public static readonly FileInfo DefaultFile; static BootstrapperApplicationData() @@ -20,12 +37,21 @@ namespace WixToolset.Mba.Core DefaultFile = new FileInfo(Path.Combine(DefaultFolder.FullName, DefaultFileName)); } + /// public FileInfo BADataFile { get; private set; } + /// public IBundleInfo Bundle { get; private set; } + /// + /// Uses the default location for BootstrapperApplicationData.xml. + /// public BootstrapperApplicationData() : this(DefaultFile) { } + /// + /// Uses the given file for BootstrapperApplicationData.xml. + /// + /// public BootstrapperApplicationData(FileInfo baDataFile) { this.BADataFile = baDataFile; @@ -36,6 +62,12 @@ namespace WixToolset.Mba.Core } } + /// + /// Utility method for parsing BootstrapperApplicationData.xml. + /// + /// + /// + /// public static string GetAttribute(XPathNavigator node, string attributeName) { XPathNavigator attribute = node.SelectSingleNode("@" + attributeName); @@ -48,6 +80,12 @@ namespace WixToolset.Mba.Core return attribute.Value; } + /// + /// Utility method for parsing BootstrapperApplicationData.xml. + /// + /// + /// + /// public static bool? GetYesNoAttribute(XPathNavigator node, string attributeName) { string attributeValue = GetAttribute(node, attributeName); -- cgit v1.2.3-55-g6feb