Skip to content

Commit

Permalink
Fix xml comments (#10233)
Browse files Browse the repository at this point in the history
  • Loading branch information
@JanKrivanek
JanKrivanek authored Jun 14, 2024
1 parent 8761bb7 commit a9efffc
Show file tree
Hide file tree
Showing 28 changed files with 726 additions and 726 deletions.
72 changes: 36 additions & 36 deletions src/Deprecated/Conversion/ProjectFileConverter.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ namespace Microsoft.Build.Conversion
**************************************************************************/
/// <summary>
/// This class (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
/// This class performs a project file format conversion from Visual Studio
/// .NET 2002 or 2003 to MSBuild format (for Whidbey).
/// </summary>
Expand Down Expand Up @@ -207,9 +207,9 @@ public sealed class ProjectFileConverter

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Default constructor. We need a constructor that takes zero parameters,
/// because this class needs to be instantiated from COM.
Expand Down Expand Up @@ -239,9 +239,9 @@ public ProjectFileConverter

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// The read/write accessor for the old project filename. This must be
/// set by the consumer before calling Convert().
Expand Down Expand Up @@ -271,9 +271,9 @@ public string OldProjectFile

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// The read/write accessor for the new project filename. This must be
/// set by the consumer before calling Convert().
Expand Down Expand Up @@ -303,9 +303,9 @@ public string NewProjectFile

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// The read/write accessor for the boolean which tells the converter
/// whether the project file we're converting is a "main" project file
Expand Down Expand Up @@ -338,9 +338,9 @@ public bool IsUserFile

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// The read/write accessor for the solution file which contains this
/// project being converted. This is used to look up information about the
Expand Down Expand Up @@ -371,9 +371,9 @@ public string SolutionFile

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Indicates if the last attempted conversion was skipped because the project is already in the latest format.
/// This will always return false;
Expand All @@ -400,9 +400,9 @@ public bool ConversionSkippedBecauseProjectAlreadyConverted

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// This property returns the list of warnings that were generated during the conversion
/// </summary>
Expand All @@ -429,9 +429,9 @@ public string[] ConversionWarnings

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Is the conversion a minor upgrade operation?
/// Minor upgrade also means the converted project file can be opened in old VS as well, so we won't update the tools version.
Expand Down Expand Up @@ -461,9 +461,9 @@ public bool IsMinorUpgrade

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// This is the entry point method, which performs the project file format
/// conversion. This method will overwrite "newProjectFile" if it already
Expand Down Expand Up @@ -1064,9 +1064,9 @@ private bool FixTargetFrameworkSubset()

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Performs conversions specific to F# projects (VS2008 CTP -> VS2012) and (VS2010 -> VS2012).
/// This involves: changing the location of FSharp targets,
Expand Down Expand Up @@ -1515,9 +1515,9 @@ private bool VBSpecificConversions()

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// This is the entry point method, which performs the project file format
/// conversion. This method will simply create a new MSBuild Project object
Expand Down
78 changes: 39 additions & 39 deletions src/Deprecated/Engine/Engine/BuildTask.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ namespace Microsoft.Build.BuildEngine
{
/// <summary>
/// This class (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// This class represents a single task.
/// </summary>
Expand Down Expand Up @@ -144,9 +144,9 @@ internal XmlElement TaskXmlElement

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Accessor for the task's "name" element.
/// </summary>
Expand All @@ -171,9 +171,9 @@ public string Name

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Accessor for the task's "condition".
/// </summary>
Expand Down Expand Up @@ -215,9 +215,9 @@ public string Condition

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Accessor for the task's "ContinueOnError".
/// </summary>
Expand Down Expand Up @@ -284,9 +284,9 @@ public bool ContinueOnError

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// System.Type object corresponding to the task class that implements
/// the functionality that runs this task object.
Expand Down Expand Up @@ -336,9 +336,9 @@ public Type Type

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Accessor for the "host object" for this task.
/// </summary>
Expand Down Expand Up @@ -390,9 +390,9 @@ internal Target ParentTarget

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// This retrieves the list of all parameter names from the element
/// node of this task. Note that it excludes anything that a specific
Expand Down Expand Up @@ -438,9 +438,9 @@ public string[] GetParameterNames()

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// This retrieves an arbitrary attribute from the task element. These
/// are attributes that the project author has placed on the task element
Expand Down Expand Up @@ -478,9 +478,9 @@ string attributeName

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// This sets an arbitrary attribute on the task element. These
/// are attributes that the project author has placed on the task element
Expand Down Expand Up @@ -514,9 +514,9 @@ bool treatParameterValueAsLiteral

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// This sets an arbitrary attribute on the task element. These
/// are attributes that the project author has placed on the task element
Expand Down Expand Up @@ -560,9 +560,9 @@ string parameterValue

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Adds an Output tag to this task element
/// </summary>
Expand Down Expand Up @@ -615,9 +615,9 @@ internal void AddOutputItem(string taskParameter, string itemName, string condit

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Adds an Output tag to this task element
/// </summary>
Expand Down Expand Up @@ -654,9 +654,9 @@ public void AddOutputProperty(string taskParameter, string propertyName)

/// <summary>
/// This method (and the whole namespace) is deprecated. Please use the classes in these namespaces instead:
/// <xref:Microsoft.Build.Construction>
/// <xref:Microsoft.Build.Evaluation>
/// <xref:Microsoft.Build.Execution>
/// <see href="/dotnet/api/microsoft.build.construction">Microsoft.Build.Construction</see>
/// <see href="/dotnet/api/microsoft.build.evaluation">Microsoft.Build.Evaluation</see>
/// <see href="/dotnet/api/microsoft.build.execution">Microsoft.Build.Execution</see>
///
/// Runs the task associated with this object.
/// </summary>
Expand Down
Loading

0 comments on commit a9efffc

Please sign in to comment.