From 86b0b0a16002d2cd0c85fc6778b9d761e8f1f762 Mon Sep 17 00:00:00 2001 From: Sean Gilliam Date: Thu, 19 Mar 2015 16:51:42 -0500 Subject: [PATCH] Xmldoc fixes Fixes for missing tags, extraneous tags, and invalid characters. --- src/Shared/FrameworkLocationHelper.cs | 1 + src/Utilities/ToolLocationHelper.cs | 2 +- .../BackEnd/Components/RequestBuilder/Lookup.cs | 2 +- .../Collections/RetrievableEntryHashSet/HashSet.cs | 4 ++-- .../Evaluation/Conditionals/LessThanExpressionNode.cs | 2 +- .../Conditionals/LessThanOrEqualExpressionNode.cs | 2 +- .../DistributedLoggers/ConfigurableForwardingLogger.cs | 2 +- src/XMakeBuildEngine/Resources/Constants.cs | 1 + src/XMakeBuildEngine/UnitTests/BackEnd/Lookup_Tests.cs | 1 + .../UnitTests/Definition/ItemDefinitionGroup_Tests.cs | 2 ++ src/XMakeTasks/AppConfig/AppConfig.cs | 2 +- src/XMakeTasks/AppConfig/BindingRedirect.cs | 4 ++-- src/XMakeTasks/AppConfig/DependentAssembly.cs | 4 ++-- src/XMakeTasks/AppConfig/RuntimeSection.cs | 4 ++-- .../AssemblyDependency/AssemblyFoldersExResolver.cs | 4 ++-- .../AssemblyDependency/AssemblyFoldersResolver.cs | 2 +- src/XMakeTasks/AssemblyDependency/AssemblyResolution.cs | 2 +- .../AssemblyDependency/CandidateAssemblyFilesResolver.cs | 2 +- src/XMakeTasks/AssemblyDependency/DirectoryResolver.cs | 2 +- src/XMakeTasks/AssemblyDependency/FrameworkPathResolver.cs | 2 +- src/XMakeTasks/AssemblyDependency/GacResolver.cs | 2 +- src/XMakeTasks/AssemblyDependency/HintPathResolver.cs | 2 +- src/XMakeTasks/AssemblyDependency/RawFilenameResolver.cs | 2 +- src/XMakeTasks/AssemblyDependency/Reference.cs | 6 +++--- src/XMakeTasks/AssemblyDependency/Resolver.cs | 4 ++-- src/XMakeTasks/AssemblyFolder.cs | 4 ++-- src/XMakeTasks/AssignCulture.cs | 4 ++-- src/XMakeTasks/AssignTargetPath.cs | 2 +- src/XMakeTasks/CommandLineBuilderExtension.cs | 4 ++-- src/XMakeTasks/GenerateResource.cs | 3 ++- src/XMakeTasks/UnitTests/ResolveAssemblyReference_Tests.cs | 3 +-- src/XMakeTasks/Vbc.cs | 2 +- 32 files changed, 45 insertions(+), 40 deletions(-) diff --git a/src/Shared/FrameworkLocationHelper.cs b/src/Shared/FrameworkLocationHelper.cs index f2d0cd97177..2f53883ecef 100644 --- a/src/Shared/FrameworkLocationHelper.cs +++ b/src/Shared/FrameworkLocationHelper.cs @@ -1515,6 +1515,7 @@ public override string GetPathToDotNetFrameworkSdk(VisualStudioSpec visualStudio /// /// Gets the full path of reference assemblies folder, which is the full path of .net framework for v1.1 and v2.0. + /// public override string GetPathToDotNetFrameworkReferenceAssemblies() { return this.GetPathToDotNetFramework(DotNetFrameworkArchitecture.Current); diff --git a/src/Utilities/ToolLocationHelper.cs b/src/Utilities/ToolLocationHelper.cs index 14cff3697b4..35ec98f200d 100644 --- a/src/Utilities/ToolLocationHelper.cs +++ b/src/Utilities/ToolLocationHelper.cs @@ -534,7 +534,7 @@ public static IList GetSDKReferenceFolders(string sdkRoot, string target } /// - /// Add the set of paths for where sdk files should be found. Where is redist, references, designtime + /// Add the set of paths for where sdk files should be found. Where <folderType> is redist, references, designtime /// private static void AddSDKPaths(string sdkRoot, string folderName, string targetConfiguration, string targetArchitecture, List directories) { diff --git a/src/XMakeBuildEngine/BackEnd/Components/RequestBuilder/Lookup.cs b/src/XMakeBuildEngine/BackEnd/Components/RequestBuilder/Lookup.cs index f8ce22652c2..b9a4ed54048 100644 --- a/src/XMakeBuildEngine/BackEnd/Components/RequestBuilder/Lookup.cs +++ b/src/XMakeBuildEngine/BackEnd/Components/RequestBuilder/Lookup.cs @@ -900,7 +900,7 @@ private ProjectItemInstance RetrieveOriginalFromCloneTable(ProjectItemInstance i } /// - /// Applies a list of modifications to the appropriate ItemDictionary in a main table. + /// Applies a list of modifications to the appropriate in a main table. /// If any modifications conflict, these modifications win. /// private void ApplyModificationsToTable(ItemDictionary table, string itemType, ItemsMetadataUpdateDictionary modify) diff --git a/src/XMakeBuildEngine/Collections/RetrievableEntryHashSet/HashSet.cs b/src/XMakeBuildEngine/Collections/RetrievableEntryHashSet/HashSet.cs index f38237d42bd..5df8b28e138 100644 --- a/src/XMakeBuildEngine/Collections/RetrievableEntryHashSet/HashSet.cs +++ b/src/XMakeBuildEngine/Collections/RetrievableEntryHashSet/HashSet.cs @@ -47,7 +47,7 @@ namespace Microsoft.Build.Collections { /// /// Implementation notes: - /// This uses an array-based implementation similar to Dictionary, using a buckets array + /// This uses an array-based implementation similar to , using a buckets array /// to map hash values to the Slots array. Items in the Slots array that hash to the same value /// are chained together through the "next" indices. /// @@ -249,7 +249,7 @@ internal T this[string name] } /// - /// Add item to this hashset. This is the explicit implementation of the ICollection + /// Add item to this hashset. This is the explicit implementation of the /// interface. The other Add method returns bool indicating whether item was added. /// /// item to add diff --git a/src/XMakeBuildEngine/Evaluation/Conditionals/LessThanExpressionNode.cs b/src/XMakeBuildEngine/Evaluation/Conditionals/LessThanExpressionNode.cs index 1e6d11e37a9..61c2caa62f9 100644 --- a/src/XMakeBuildEngine/Evaluation/Conditionals/LessThanExpressionNode.cs +++ b/src/XMakeBuildEngine/Evaluation/Conditionals/LessThanExpressionNode.cs @@ -11,7 +11,7 @@ namespace Microsoft.Build.Evaluation { /// - /// Compares for left < right + /// Compares for left < right /// internal sealed class LessThanExpressionNode : NumericComparisonExpressionNode { diff --git a/src/XMakeBuildEngine/Evaluation/Conditionals/LessThanOrEqualExpressionNode.cs b/src/XMakeBuildEngine/Evaluation/Conditionals/LessThanOrEqualExpressionNode.cs index 4c1b623e229..892fa2a5fa7 100644 --- a/src/XMakeBuildEngine/Evaluation/Conditionals/LessThanOrEqualExpressionNode.cs +++ b/src/XMakeBuildEngine/Evaluation/Conditionals/LessThanOrEqualExpressionNode.cs @@ -11,7 +11,7 @@ namespace Microsoft.Build.Evaluation { /// - /// Compares for left <= right + /// Compares for left <= right /// internal sealed class LessThanOrEqualExpressionNode : NumericComparisonExpressionNode { diff --git a/src/XMakeBuildEngine/Logging/DistributedLoggers/ConfigurableForwardingLogger.cs b/src/XMakeBuildEngine/Logging/DistributedLoggers/ConfigurableForwardingLogger.cs index 5b08f251411..5af00d93ac1 100644 --- a/src/XMakeBuildEngine/Logging/DistributedLoggers/ConfigurableForwardingLogger.cs +++ b/src/XMakeBuildEngine/Logging/DistributedLoggers/ConfigurableForwardingLogger.cs @@ -500,7 +500,7 @@ private bool IsVerbosityAtLeast(LoggerVerbosity checkVerbosity) /// /// A table indicating if a particular event type should be forwarded /// The value is type int rather than bool to avoid the problem of JITting generics. - /// Dictionary is already compiled into mscorlib. + /// is already compiled into mscorlib. /// private Dictionary _forwardingTable; diff --git a/src/XMakeBuildEngine/Resources/Constants.cs b/src/XMakeBuildEngine/Resources/Constants.cs index 826f05b4e2b..804f69b3068 100644 --- a/src/XMakeBuildEngine/Resources/Constants.cs +++ b/src/XMakeBuildEngine/Resources/Constants.cs @@ -152,6 +152,7 @@ internal static class Constants /// internal static long assemblyTimestamp; + /// /// Current version of this MSBuild Engine assembly in the /// form, e.g, "4.0" /// diff --git a/src/XMakeBuildEngine/UnitTests/BackEnd/Lookup_Tests.cs b/src/XMakeBuildEngine/UnitTests/BackEnd/Lookup_Tests.cs index 18d507ad13a..62e0378aafc 100644 --- a/src/XMakeBuildEngine/UnitTests/BackEnd/Lookup_Tests.cs +++ b/src/XMakeBuildEngine/UnitTests/BackEnd/Lookup_Tests.cs @@ -593,6 +593,7 @@ public void KeepMetadataOnlySpecifiedPropagate3() /// /// Ensure that once keepOnlySpecified is set to true, it remains in effect, and that if a metadata modification is declared as 'keep value' that /// the value as lower scopes is retained. + /// [TestMethod] public void KeepMetadataOnlySpecifiedPropagate4() { diff --git a/src/XMakeBuildEngine/UnitTests/Definition/ItemDefinitionGroup_Tests.cs b/src/XMakeBuildEngine/UnitTests/Definition/ItemDefinitionGroup_Tests.cs index d18a8f9b6e1..98a9259f499 100644 --- a/src/XMakeBuildEngine/UnitTests/Definition/ItemDefinitionGroup_Tests.cs +++ b/src/XMakeBuildEngine/UnitTests/Definition/ItemDefinitionGroup_Tests.cs @@ -1215,6 +1215,7 @@ public void DefinitionInImportedFile() /// /// Item added to project should pick up the item /// definitions that project has. + /// [TestMethod] public void ProjectAddNewItemPicksUpProjectItemDefinitions() { @@ -1237,6 +1238,7 @@ public void ProjectAddNewItemPicksUpProjectItemDefinitions() /// /// Item added to project should pick up the item /// definitions that project has. + /// [TestMethod] public void ProjectAddNewItemExistingGroupPicksUpProjectItemDefinitions() { diff --git a/src/XMakeTasks/AppConfig/AppConfig.cs b/src/XMakeTasks/AppConfig/AppConfig.cs index 865c3fcd377..d28a1632ffa 100644 --- a/src/XMakeTasks/AppConfig/AppConfig.cs +++ b/src/XMakeTasks/AppConfig/AppConfig.cs @@ -17,7 +17,7 @@ namespace Microsoft.Build.Tasks internal sealed class AppConfig { /// - /// Corresponds to the contents of the element. + /// Corresponds to the contents of the <runtime> element. /// private RuntimeSection _runtime = new RuntimeSection(); diff --git a/src/XMakeTasks/AppConfig/BindingRedirect.cs b/src/XMakeTasks/AppConfig/BindingRedirect.cs index a63e4b9972c..8c9e83aa1ed 100644 --- a/src/XMakeTasks/AppConfig/BindingRedirect.cs +++ b/src/XMakeTasks/AppConfig/BindingRedirect.cs @@ -9,7 +9,7 @@ namespace Microsoft.Build.Tasks { /// - /// Represents a single from the app.config file. + /// Represents a single <bindingRedirect> from the app.config file. /// internal sealed class BindingRedirect { @@ -56,7 +56,7 @@ internal Version NewVersion } /// - /// The reader is positioned on a element--read it. + /// The reader is positioned on a <bindingRedirect> element--read it. /// /// internal void Read(XmlTextReader reader) diff --git a/src/XMakeTasks/AppConfig/DependentAssembly.cs b/src/XMakeTasks/AppConfig/DependentAssembly.cs index 3ab37f13300..fdd453de14e 100644 --- a/src/XMakeTasks/AppConfig/DependentAssembly.cs +++ b/src/XMakeTasks/AppConfig/DependentAssembly.cs @@ -12,7 +12,7 @@ namespace Microsoft.Build.Tasks { /// - /// Represents a single from the app.config file. + /// Represents a single <dependentassembly> from the app.config file. /// internal sealed class DependentAssembly { @@ -47,7 +47,7 @@ internal AssemblyName PartialAssemblyName } /// - /// The reader is positioned on a element--read it. + /// The reader is positioned on a <dependentassembly> element--read it. /// /// internal void Read(XmlTextReader reader) diff --git a/src/XMakeTasks/AppConfig/RuntimeSection.cs b/src/XMakeTasks/AppConfig/RuntimeSection.cs index 0a7a5506744..8afa82bcc96 100644 --- a/src/XMakeTasks/AppConfig/RuntimeSection.cs +++ b/src/XMakeTasks/AppConfig/RuntimeSection.cs @@ -8,7 +8,7 @@ namespace Microsoft.Build.Tasks { /// - /// Wraps the section of the .config file. + /// Wraps the <runtime> section of the .config file. /// internal sealed class RuntimeSection { @@ -18,7 +18,7 @@ internal sealed class RuntimeSection private ArrayList _dependentAssemblies = new ArrayList(); /// - /// The reader is positioned on a element--read it. + /// The reader is positioned on a <runtime> element--read it. /// /// internal void Read(XmlTextReader reader) diff --git a/src/XMakeTasks/AssemblyDependency/AssemblyFoldersExResolver.cs b/src/XMakeTasks/AssemblyDependency/AssemblyFoldersExResolver.cs index 6bc1d3b01e6..80896b21f87 100644 --- a/src/XMakeTasks/AssemblyDependency/AssemblyFoldersExResolver.cs +++ b/src/XMakeTasks/AssemblyDependency/AssemblyFoldersExResolver.cs @@ -108,7 +108,7 @@ internal AssemblyFoldersEx AssemblyFoldersExLocations /// /// Construct. - /// public AssemblyFoldersExResolver(string searchPathElement, GetAssemblyName getAssemblyName, FileExists fileExists, GetRegistrySubKeyNames getRegistrySubKeyNames, GetRegistrySubKeyDefaultValue getRegistrySubKeyDefaultValue, GetAssemblyRuntimeVersion getRuntimeVersion, OpenBaseKey openBaseKey, Version targetedRuntimeVesion, ProcessorArchitecture targetProcessorArchitecture, bool compareProcessorArchitecture, IBuildEngine buildEngine) : base(searchPathElement, getAssemblyName, fileExists, getRuntimeVersion, targetedRuntimeVesion, targetProcessorArchitecture, compareProcessorArchitecture) { @@ -200,7 +200,7 @@ private void LazyInitialize() /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. /// Whether or not the user wanted a specific file (for example, HintPath is a request for a specific file) diff --git a/src/XMakeTasks/AssemblyDependency/AssemblyFoldersResolver.cs b/src/XMakeTasks/AssemblyDependency/AssemblyFoldersResolver.cs index a455c09e104..aa8f30a4673 100644 --- a/src/XMakeTasks/AssemblyDependency/AssemblyFoldersResolver.cs +++ b/src/XMakeTasks/AssemblyDependency/AssemblyFoldersResolver.cs @@ -33,7 +33,7 @@ public AssemblyFoldersResolver(string searchPathElement, GetAssemblyName getAsse /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. /// Whether or not the user wanted a specific file (for example, HintPath is a request for a specific file) diff --git a/src/XMakeTasks/AssemblyDependency/AssemblyResolution.cs b/src/XMakeTasks/AssemblyDependency/AssemblyResolution.cs index 3978c0183d2..414f93c94b1 100644 --- a/src/XMakeTasks/AssemblyDependency/AssemblyResolution.cs +++ b/src/XMakeTasks/AssemblyDependency/AssemblyResolution.cs @@ -40,7 +40,7 @@ internal static class AssemblyResolution /// True if this is a primary reference directly from the project file. /// The filename extension of the assembly. Must be this or its no match. /// This reference's hintpath - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// Receives the searchPath that the reference was resolved at. Empty if not resolved. /// This will be true if the user requested a specific file. diff --git a/src/XMakeTasks/AssemblyDependency/CandidateAssemblyFilesResolver.cs b/src/XMakeTasks/AssemblyDependency/CandidateAssemblyFilesResolver.cs index d014f979796..6d01bf7ef2e 100644 --- a/src/XMakeTasks/AssemblyDependency/CandidateAssemblyFilesResolver.cs +++ b/src/XMakeTasks/AssemblyDependency/CandidateAssemblyFilesResolver.cs @@ -41,7 +41,7 @@ public CandidateAssemblyFilesResolver(string[] candidateAssemblyFiles, string se /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. /// Whether or not the user wanted a specific file (for example, HintPath is a request for a specific file) diff --git a/src/XMakeTasks/AssemblyDependency/DirectoryResolver.cs b/src/XMakeTasks/AssemblyDependency/DirectoryResolver.cs index 27a0e7e0fca..c15a5cf4d12 100644 --- a/src/XMakeTasks/AssemblyDependency/DirectoryResolver.cs +++ b/src/XMakeTasks/AssemblyDependency/DirectoryResolver.cs @@ -34,7 +34,7 @@ public DirectoryResolver(string searchPathElement, GetAssemblyName getAssemblyNa /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. /// Whether or not the user wanted a specific file (for example, HintPath is a request for a specific file) diff --git a/src/XMakeTasks/AssemblyDependency/FrameworkPathResolver.cs b/src/XMakeTasks/AssemblyDependency/FrameworkPathResolver.cs index 2cefcfe3817..22fd35d4727 100644 --- a/src/XMakeTasks/AssemblyDependency/FrameworkPathResolver.cs +++ b/src/XMakeTasks/AssemblyDependency/FrameworkPathResolver.cs @@ -44,7 +44,7 @@ public FrameworkPathResolver(string[] frameworkPaths, InstalledAssemblies instal /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. /// Whether or not the user wanted a specific file (for example, HintPath is a request for a specific file) diff --git a/src/XMakeTasks/AssemblyDependency/GacResolver.cs b/src/XMakeTasks/AssemblyDependency/GacResolver.cs index 2c4c898c16c..5d2a1bae846 100644 --- a/src/XMakeTasks/AssemblyDependency/GacResolver.cs +++ b/src/XMakeTasks/AssemblyDependency/GacResolver.cs @@ -40,7 +40,7 @@ public GacResolver(System.Reflection.ProcessorArchitecture targetProcessorArchit /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// List of literal assembly file names to be considered when SearchPaths has {CandidateAssemblyFiles}. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. diff --git a/src/XMakeTasks/AssemblyDependency/HintPathResolver.cs b/src/XMakeTasks/AssemblyDependency/HintPathResolver.cs index 197565198e5..d5ee4fef2be 100644 --- a/src/XMakeTasks/AssemblyDependency/HintPathResolver.cs +++ b/src/XMakeTasks/AssemblyDependency/HintPathResolver.cs @@ -34,7 +34,7 @@ public HintPathResolver(string searchPathElement, GetAssemblyName getAssemblyNam /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. /// Whether or not the user wanted a specific file (for example, HintPath is a request for a specific file) diff --git a/src/XMakeTasks/AssemblyDependency/RawFilenameResolver.cs b/src/XMakeTasks/AssemblyDependency/RawFilenameResolver.cs index f4d3ecfc35f..58e7c2bb42d 100644 --- a/src/XMakeTasks/AssemblyDependency/RawFilenameResolver.cs +++ b/src/XMakeTasks/AssemblyDependency/RawFilenameResolver.cs @@ -35,7 +35,7 @@ public RawFilenameResolver(string searchPathElement, GetAssemblyName getAssembly /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. /// Whether or not the user wanted a specific file (for example, HintPath is a request for a specific file) diff --git a/src/XMakeTasks/AssemblyDependency/Reference.cs b/src/XMakeTasks/AssemblyDependency/Reference.cs index 5cab716a992..83939adac9e 100644 --- a/src/XMakeTasks/AssemblyDependency/Reference.cs +++ b/src/XMakeTasks/AssemblyDependency/Reference.cs @@ -189,7 +189,7 @@ sealed internal class Reference private bool _embedInteropTypes = false; /// - /// This is the key that was passed in to the reference through the metadata. + /// This is the key that was passed in to the reference through the <AssemblyFolderKey> metadata. /// private string _assemblyFolderKey = String.Empty; @@ -718,9 +718,9 @@ internal string HintPath } /// - /// This is the key that was passed in to the reference through the metadata. + /// This is the key that was passed in to the reference through the <AssemblyFolderKey> metadata. /// - /// The value. + /// The <AssemblyFolderKey> value. internal string AssemblyFolderKey { get { return _assemblyFolderKey; } diff --git a/src/XMakeTasks/AssemblyDependency/Resolver.cs b/src/XMakeTasks/AssemblyDependency/Resolver.cs index 448f8e750c2..4c479c7d2e1 100644 --- a/src/XMakeTasks/AssemblyDependency/Resolver.cs +++ b/src/XMakeTasks/AssemblyDependency/Resolver.cs @@ -67,13 +67,13 @@ protected Resolver(string searchPathElement, GetAssemblyName getAssemblyName, Fi /// Resolve a reference to a specific file name. /// /// The assemblyname of the reference. - /// The name of the sdk to resolve. + /// The name of the sdk to resolve. /// The reference's 'include' treated as a raw file name. /// Whether or not this reference was directly from the project file (and therefore not a dependency) /// Whether an exact version match is requested. /// Allowed executable extensions. /// The item's hintpath value. - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Receives the list of locations that this function tried to find the assembly. May be "null". /// The path where the file was found. /// Whether or not the user wanted a specific file (for example, HintPath is a request for a specific file) diff --git a/src/XMakeTasks/AssemblyFolder.cs b/src/XMakeTasks/AssemblyFolder.cs index 4b88bcd032e..6cb57171cf6 100644 --- a/src/XMakeTasks/AssemblyFolder.cs +++ b/src/XMakeTasks/AssemblyFolder.cs @@ -19,7 +19,7 @@ namespace Microsoft.Build.Tasks internal static class AssemblyFolder { /// - /// Key -- Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project + /// Key -- Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project /// Value -- Directory /// private static Hashtable s_assemblyFolders; @@ -130,7 +130,7 @@ private static void CreateAssemblyFolders() /// /// Returns the list of assembly folders that we're interested in. /// - /// Like "hklm\Vendor RegKey" as provided to a reference by the on the reference in the project. + /// Like "hklm\Vendor RegKey" as provided to a reference by the <AssemblyFolderKey> on the reference in the project. /// Collection of assembly folders. static internal ICollection GetAssemblyFolders(string regKeyAlias) { diff --git a/src/XMakeTasks/AssignCulture.cs b/src/XMakeTasks/AssignCulture.cs index e67b3a97e3e..a67bf0f965c 100644 --- a/src/XMakeTasks/AssignCulture.cs +++ b/src/XMakeTasks/AssignCulture.cs @@ -63,9 +63,9 @@ public ITaskItem[] Files /// list except that an attribute name "Culture" will have been added if /// the particular file name is in the form: /// - /// MyResource..resx + /// MyResource.<any-valid-culture-id>.resx /// - /// The value of Culture will be "". + /// The value of Culture will be "<any-valid-culture-id>". /// /// If the incoming item from Files already has a Culture attribute then /// that original attribute is used instead. diff --git a/src/XMakeTasks/AssignTargetPath.cs b/src/XMakeTasks/AssignTargetPath.cs index d3a6a2f9ac6..c38fc956229 100644 --- a/src/XMakeTasks/AssignTargetPath.cs +++ b/src/XMakeTasks/AssignTargetPath.cs @@ -15,7 +15,7 @@ namespace Microsoft.Build.Tasks { /// - /// Create a new list of items that have attributes if none was present in + /// Create a new list of items that have <TargetPath> attributes if none was present in /// the input. /// public class AssignTargetPath : TaskExtension diff --git a/src/XMakeTasks/CommandLineBuilderExtension.cs b/src/XMakeTasks/CommandLineBuilderExtension.cs index 47fd8a24f44..3def3bc4600 100644 --- a/src/XMakeTasks/CommandLineBuilderExtension.cs +++ b/src/XMakeTasks/CommandLineBuilderExtension.cs @@ -224,8 +224,8 @@ internal static bool IsParameterEmpty(string parameter, params char[] splitOn) /// /// Designed to handle the /link and /embed swithes: /// - /// /embed[resource]:[,[,Private]] - /// /link[resource]:[,[,Private]] + /// /embed[resource]:<filename>[,<name>[,Private]] + /// /link[resource]:<filename>[,<name>[,Private]] /// /// Where the last flag--Private--is either present or not present /// depending on whether the ITaskItem has a Private="True" attribue. diff --git a/src/XMakeTasks/GenerateResource.cs b/src/XMakeTasks/GenerateResource.cs index 6a4daba76bd..2c9c4a06fca 100644 --- a/src/XMakeTasks/GenerateResource.cs +++ b/src/XMakeTasks/GenerateResource.cs @@ -1015,7 +1015,7 @@ private bool TransformResourceFilesUsingResGen(List inputsToProcess, /// /// Given the list of inputs and outputs, returns the number of resources (starting at the provided initial index) /// that can fit onto the commandline without exceeding MaximumCommandLength. - /// + /// private int CalculateResourceBatchSize(List inputsToProcess, List outputsToProcess, string resourcelessCommand, int initialResourceIndex) { CommandLineBuilderExtension currentCommand = new CommandLineBuilderExtension(); @@ -1283,6 +1283,7 @@ private bool ContainsDuplicates(IList originalList) /// Determines if the given output file is up to date with respect to the /// the given input file by comparing timestamps of the two files as well as /// (if the source is a .resx) the linked files inside the .resx file itself + /// /// /// /// diff --git a/src/XMakeTasks/UnitTests/ResolveAssemblyReference_Tests.cs b/src/XMakeTasks/UnitTests/ResolveAssemblyReference_Tests.cs index 0d0e6be3810..d5c3c428776 100644 --- a/src/XMakeTasks/UnitTests/ResolveAssemblyReference_Tests.cs +++ b/src/XMakeTasks/UnitTests/ResolveAssemblyReference_Tests.cs @@ -3746,7 +3746,6 @@ public void ExistsDifferentName() /// dependencies anyway to make things work consistently. This would be a significant /// perf hit when loading large solutions. /// - /// [TestMethod] public void ExistsOldVersionRange() { @@ -4712,7 +4711,7 @@ public void GarbageAppConfigMissingNewVersion() /// /// In this case, - /// - An app.config is passed in that has some missing information in element. + /// - An app.config is passed in that has some missing information in <assemblyIdentity> element. /// Expected: /// - An error and task failure. /// Rationale: diff --git a/src/XMakeTasks/Vbc.cs b/src/XMakeTasks/Vbc.cs index abba77965ba..396b7c1a6a3 100644 --- a/src/XMakeTasks/Vbc.cs +++ b/src/XMakeTasks/Vbc.cs @@ -350,7 +350,7 @@ override protected string GenerateFullPathToTool() /// /// vbc.exe only takes the BaseAddress in hexadecimal format. But we allow the caller /// of the task to pass in the BaseAddress in either decimal or hexadecimal format. - /// Examples of supported hex formats include "0x10000000" or "&H10000000". + /// Examples of supported hex formats include "0x10000000" or "&H10000000". /// internal string GetBaseAddressInHex() {