Start updating the documentation comments (QOL) #4689
Conversation
github-actions
bot
requested review from
bgavrilMS,
gladjohn,
neha-bhargava,
pmaytak and
trwalke
|
Is this PR part of bigger set of comment updates? What's in scope? |
I am cleaning up the comments across the entire library. Every part of MSAL.NET is in scope, but I will make sure that this is limited in number of changes to keep the PR reviewable. |
src/client/Microsoft.Identity.Client/UiRequiredExceptionClassification.cs
Outdated
Show resolved
Hide resolved
| @@ -5,6 +5,7 @@ | |||
| using System.ComponentModel; | |||
| using System.Runtime.InteropServices; | |||
| using Microsoft.Identity.Client.PlatformsCommon.Interfaces; | |||
| using static System.Net.WebRequestMethods; | |||
There was a problem hiding this comment.
Yeah I am actually not sure why this was added. Will remove. Assuming over-eager IntelliSense/IntelliCode.
| @@ -75,6 +75,7 @@ private static string GetAuthority() | |||
|
|
|||
| private static IPublicClientApplication CreatePca(bool withWamBroker = false) | |||
| { | |||
| // <PCABootstrapSample> | |||
There was a problem hiding this comment.
What is this for? Note that this isn't great as a sample, because the token caching is done in a plaintext file.
src/client/Microsoft.Identity.Client/Kerberos/KerberosSupplementalTicketManager.cs
Outdated
Show resolved
Hide resolved
src/client/Microsoft.Identity.Client/Kerberos/KerberosSupplementalTicketManager.cs
Outdated
Show resolved
Hide resolved
|
@localden Is this ready for review? Should this be set to draft? Seems like there are still additions being done. |
|
@pmaytak yep, this should be ready for review. I am done with this batch, and for future PRs will keep them in draft. |
bgavrilMS
force-pushed
the
ddelimarsky/docfix
branch
from
f4c1263
to
98d32bc
Compare
|
Can I merge this @localden ? |
|
@bgavrilMS absolutely! |
…fication.cs Co-authored-by: Peter <34331512+pmaytak@users.noreply.github.com>
…ntalTicketManager.cs Co-authored-by: Gladwin Johnson <90415114+gladjohn@users.noreply.github.com>
…ntalTicketManager.cs Co-authored-by: Gladwin Johnson <90415114+gladjohn@users.noreply.github.com>
Co-authored-by: Gladwin Johnson <90415114+gladjohn@users.noreply.github.com>
Co-authored-by: Gladwin Johnson <90415114+gladjohn@users.noreply.github.com>
bgavrilMS
force-pushed
the
ddelimarsky/docfix
branch
from
98d32bc
to
5c08d15
Compare
This fix addresses API documentation comments. It's a Quality-of-Life (QOL) improvement that points people to more resources and includes examples, where relevant.