Fixed cross references and some invalid tags (#10568)

* Fixed cross references and some invalid tags
* Removing internal note from public documentation
This commit is contained in:
MichalPavlik 2024-08-28 12:59:37 +02:00 коммит произвёл GitHub
Родитель 6fba9a98f6
Коммит a03ee4ba9c
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
4 изменённых файлов: 4 добавлений и 7 удалений

Просмотреть файл

@ -32,9 +32,7 @@ namespace Microsoft.Build.Execution
/// <summary>
/// Contains the current results for all of the targets which have produced results for a particular configuration.
/// </summary>
/// <remarks>
/// When modifying serialization/deserialization, bump the version and support previous versions in order to keep <see cref="ResultsCache"/> backwards compatible.
/// </remarks>
public class BuildResult : BuildResultBase, INodePacket, IBuildResults
{
/// <summary>
@ -421,7 +419,7 @@ namespace Microsoft.Build.Execution
/// See <see cref="Execution.BuildRequestDataFlags"/> for examples of the available flags.
/// </summary>
/// <remarks>
/// Is optional, this property exists starting <see cref="_version"/> 1.
/// Is optional, this property exists starting version 1.
/// </remarks>
public BuildRequestDataFlags? BuildRequestDataFlags => (_version > 0) ? _buildRequestDataFlags : null;

Просмотреть файл

@ -829,7 +829,7 @@ namespace Microsoft.Build.Evaluation
/// their previously stored value to find out, and if so perhaps decide to update their own state.
/// Note that the number may not increase monotonically.
///
/// This number corresponds to the <seealso cref="BuildEventContext.EvaluationId"/> and can be used to connect
/// This number corresponds to the <see cref="BuildEventContext.EvaluationId"/> and can be used to connect
/// evaluation logging events back to the Project instance.
/// </summary>
public int LastEvaluationId => implementation.LastEvaluationId;
@ -1981,7 +1981,6 @@ namespace Microsoft.Build.Evaluation
/// - <see cref="RemoveItems"/>
/// - <see cref="AddItem(string,string, IEnumerable&lt;KeyValuePair&lt;string, string&gt;&gt;)"/>
/// - <see cref="AddItemFast(string,string, IEnumerable&lt;KeyValuePair&lt;string, string&gt;&gt;)"/>
/// - <see cref="ProjectItem.ChangeItemType"/>
/// - <see cref="ProjectItem.Rename"/>
/// - <see cref="ProjectItem.RemoveMetadata"/>
/// - <see cref="ProjectItem.SetMetadataValue(string,string)"/>

Просмотреть файл

@ -85,7 +85,7 @@ namespace Microsoft.Build.Evaluation.Context
/// Factory for <see cref="EvaluationContext" />
/// </summary>
/// <param name="policy">The <see cref="SharingPolicy"/> to use.</param>
/// <param name="fileSystem">The <see cref="IFileSystem"/> to use.
/// <param name="fileSystem">The <see cref="MSBuildFileSystemBase"/> to use.
/// This parameter is compatible only with <see cref="SharingPolicy.Shared"/>.
/// The method throws if a file system is used with <see cref="SharingPolicy.Isolated"/> or <see cref="SharingPolicy.SharedSDKCache"/>.
/// The reasoning is that these values guarantee not reusing file system caches between evaluations,

Просмотреть файл

@ -42,7 +42,7 @@ namespace Microsoft.Build.Tasks
public string[] FormatArguments { get; set; } = [];
/// <summary>
/// <see cref="BuildMessageSeverity"/>.
/// Severity of the message.
/// </summary>
[Required]
public string Severity { set; get; } = string.Empty;