diff --git a/src/libraries/System.Diagnostics.FileVersionInfo/src/System/Diagnostics/FileVersionInfo.cs b/src/libraries/System.Diagnostics.FileVersionInfo/src/System/Diagnostics/FileVersionInfo.cs index b8f6a402e0807e..e284d75fb3f9a4 100644 --- a/src/libraries/System.Diagnostics.FileVersionInfo/src/System/Diagnostics/FileVersionInfo.cs +++ b/src/libraries/System.Diagnostics.FileVersionInfo/src/System/Diagnostics/FileVersionInfo.cs @@ -43,6 +43,7 @@ public sealed partial class FileVersionInfo /// /// Gets the comments associated with the file. /// + /// The comments associated with the file or if the file did not contain version information. public string? Comments { get { return _comments; } @@ -51,6 +52,7 @@ public string? Comments /// /// Gets the name of the company that produced the file. /// + /// The name of the company that produced the file or if the file did not contain version information. public string? CompanyName { get { return _companyName; } @@ -59,6 +61,7 @@ public string? CompanyName /// /// Gets the build number of the file. /// + /// A value representing the build number of the file or 0 (zero) if the file did not contain version information. public int FileBuildPart { get { return _fileBuild; } @@ -67,6 +70,7 @@ public int FileBuildPart /// /// Gets the description of the file. /// + /// The description of the file or if the file did not contain version information. public string? FileDescription { get { return _fileDescription; } @@ -75,6 +79,7 @@ public string? FileDescription /// /// Gets the major part of the version number. /// + /// A value representing the major part of the version number or 0 (zero) if the file did not contain version information. public int FileMajorPart { get { return _fileMajor; } @@ -83,6 +88,7 @@ public int FileMajorPart /// /// Gets the minor part of the version number of the file. /// + /// A value representing the minor part of the version number of the file or 0 (zero) if the file did not contain version information. public int FileMinorPart { get { return _fileMinor; } @@ -91,6 +97,7 @@ public int FileMinorPart /// /// Gets the name of the file that this instance of describes. /// + /// The name of the file described by this instance of . public string FileName { get { return _fileName; } @@ -99,6 +106,7 @@ public string FileName /// /// Gets the file private part number. /// + /// A value representing the file private part number or 0 (zero) if the file did not contain version information. public int FilePrivatePart { get { return _filePrivate; } @@ -107,6 +115,7 @@ public int FilePrivatePart /// /// Gets the file version number. /// + /// The version number of the file or if the file did not contain version information. public string? FileVersion { get { return _fileVersion; } @@ -115,24 +124,25 @@ public string? FileVersion /// /// Gets the internal name of the file, if one exists. /// + /// The internal name of the file. If none exists, this property will contain the original name of the file without the extension. public string? InternalName { get { return _internalName; } } /// - /// Gets a value that specifies whether the file contains debugging information - /// or is compiled with debugging features enabled. + /// Gets a value that specifies whether the file contains debugging information or is compiled with debugging features enabled. /// + /// if the file contains debugging information or is compiled with debugging features enabled; otherwise, . public bool IsDebug { get { return _isDebug; } } /// - /// Gets a value that specifies whether the file has been modified and is not identical to - /// the original shipping file of the same version number. + /// Gets a value that specifies whether the file has been modified and is not identical to the original shipping file of the same version number. /// + /// if the file is patched; otherwise, . public bool IsPatched { get { return _isPatched; } @@ -141,15 +151,16 @@ public bool IsPatched /// /// Gets a value that specifies whether the file was built using standard release procedures. /// + /// if the file is a private build; if the file was built using standard release procedures or if the file did not contain version information. public bool IsPrivateBuild { get { return _isPrivateBuild; } } /// - /// Gets a value that specifies whether the file - /// is a development version, rather than a commercially released product. + /// Gets a value that specifies whether the file is a development version, rather than a commercially released product. /// + /// if the file is prerelease; otherwise, . public bool IsPreRelease { get { return _isPreRelease; } @@ -158,6 +169,7 @@ public bool IsPreRelease /// /// Gets a value that specifies whether the file is a special build. /// + /// if the file is a special build; otherwise, . public bool IsSpecialBuild { get { return _isSpecialBuild; } @@ -166,6 +178,7 @@ public bool IsSpecialBuild /// /// Gets the default language string for the version info block. /// + /// The description string for the Microsoft Language Identifier in the version resource or if the file did not contain version information. public string? Language { get { return _language; } @@ -174,6 +187,7 @@ public string? Language /// /// Gets all copyright notices that apply to the specified file. /// + /// The copyright notices that apply to the specified file. public string? LegalCopyright { get { return _legalCopyright; } @@ -182,6 +196,7 @@ public string? LegalCopyright /// /// Gets the trademarks and registered trademarks that apply to the file. /// + /// The trademarks and registered trademarks that apply to the file or if the file did not contain version information. public string? LegalTrademarks { get { return _legalTrademarks; } @@ -190,6 +205,7 @@ public string? LegalTrademarks /// /// Gets the name the file was created with. /// + /// The name the file was created with or if the file did not contain version information. public string? OriginalFilename { get { return _originalFilename; } @@ -198,6 +214,7 @@ public string? OriginalFilename /// /// Gets information about a private version of the file. /// + /// Information about a private version of the file or if the file did not contain version information. public string? PrivateBuild { get { return _privateBuild; } @@ -206,6 +223,7 @@ public string? PrivateBuild /// /// Gets the build number of the product this file is associated with. /// + /// A value representing the build number of the product this file is associated with or 0 (zero) if the file did not contain version information. public int ProductBuildPart { get { return _productBuild; } @@ -214,6 +232,7 @@ public int ProductBuildPart /// /// Gets the major part of the version number for the product this file is associated with. /// + /// A value representing the major part of the product version number or 0 (zero) if the file did not contain version information. public int ProductMajorPart { get { return _productMajor; } @@ -222,6 +241,7 @@ public int ProductMajorPart /// /// Gets the minor part of the version number for the product the file is associated with. /// + /// A value representing the minor part of the product version number or 0 (zero) if the file did not contain version information. public int ProductMinorPart { get { return _productMinor; } @@ -230,6 +250,7 @@ public int ProductMinorPart /// /// Gets the name of the product this file is distributed with. /// + /// The name of the product this file is distributed with or if the file did not contain version information. public string? ProductName { get { return _productName; } @@ -238,6 +259,7 @@ public string? ProductName /// /// Gets the private part number of the product this file is associated with. /// + /// A value representing the private part number of the product this file is associated with or 0 (zero) if the file did not contain version information. public int ProductPrivatePart { get { return _productPrivate; } @@ -246,6 +268,7 @@ public int ProductPrivatePart /// /// Gets the version of the product this file is distributed with. /// + /// The version of the product this file is distributed with or if the file did not contain version information. public string? ProductVersion { get { return _productVersion; } @@ -254,6 +277,7 @@ public string? ProductVersion /// /// Gets the special build information for the file. /// + /// The special build information for the file or if the file did not contain version information. public string? SpecialBuild { get { return _specialBuild; } @@ -262,6 +286,8 @@ public string? SpecialBuild /// /// Returns a representing the version information associated with the specified file. /// + /// The fully qualified path and name of the file to retrieve the version information for. + /// A containing information about the file. If the file did not contain version information, the contains only the name of the file requested. public static FileVersionInfo GetVersionInfo(string fileName) { // Check if fileName is a full path. Relative paths can cause confusion if the local file has the .dll extension, @@ -280,9 +306,9 @@ public static FileVersionInfo GetVersionInfo(string fileName) } /// - /// Returns a partial list of properties in - /// and their values. + /// Returns a partial list of properties in the and their values. /// + /// A list of the following properties in this class and their values: , , , , , , , , , , , , . If the file did not contain version information, this list will contain only the name of the requested file. Boolean values will be , and all other entries will be . public override string ToString() { // An initial capacity of 512 was chosen because it is large enough to cover