Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update xml doc comments #193

Merged
merged 3 commits into from
Nov 12, 2022
Merged

Update xml doc comments #193

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
74a4371
Update xml doc comments
Forgind Nov 10, 2022
6d062b9
Update src/MSBuildLocator/MSBuildLocator.cs
Forgind Nov 10, 2022
f0f5eba
Update src/MSBuildLocator/MSBuildLocator.cs
Forgind Nov 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/MSBuildLocator/MSBuildLocator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@

namespace Microsoft.Build.Locator
{
/// <summary>
/// MSBuildLocator allows the use of publicly visible MSBuild APIs in custom applications. See our documentation at aka.ms/msbuild/locator.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't read much like other static classes, for example https://learn.microsoft.com/en-us/dotnet/api/system.gc?view=net-7.0. I like linking to the conceptual doc, though--is it best to do that here like this, or after the XML ingestion, @ghogen?

Suggested change
/// MSBuildLocator allows the use of publicly visible MSBuild APIs in custom applications. See our documentation at aka.ms/msbuild/locator.
/// Allows enumerating installed MSBuild instances and preparing MSBuild APIs for use.

Forgind marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
public static class MSBuildLocator
{
private const string MSBuildPublicKeyToken = "b03f5f7f11d50a3a";
Expand Down Expand Up @@ -305,8 +308,8 @@ public static void Unregister()
/// <summary>
/// Ensures the proper MSBuild environment variables are populated for DotNet SDK.
/// </summary>
/// <param name="msbuildPath">
/// Path to the directory containing the DotNet SDK.
/// <param name="dotNetSdkPath">
/// Path to the directory containing the .NET SDK.
/// </param>
private static void ApplyDotNetSdkEnvironmentVariables(string dotNetSdkPath)
{
Expand Down