Skip to content

docs(msal-angular): document MsalService methods#8531

Open
Shirshaw64p wants to merge 2 commits into
AzureAD:devfrom
Shirshaw64p:docs/msal-angular-service-jsdoc-4387
Open

docs(msal-angular): document MsalService methods#8531
Shirshaw64p wants to merge 2 commits into
AzureAD:devfrom
Shirshaw64p:docs/msal-angular-service-jsdoc-4387

Conversation

@Shirshaw64p
Copy link
Copy Markdown

Summary

Adds missing JSDoc comments for public methods in MsalService to improve generated API docs and address #4387.

Changes

  • Documented auth/token methods (initialize, �cquireToken*, login*, logout*, ssoSilent)
  • Added JSDoc for setLogger`n- Kept behavior unchanged (documentation-only update)

@Shirshaw64p Shirshaw64p requested a review from a team as a code owner April 14, 2026 02:14
Copilot AI review requested due to automatic review settings April 14, 2026 02:14
@Shirshaw64p
Copy link
Copy Markdown
Author

@AzureAD/microsoft-authentication-library-for-js-maintainers Could you please review this documentation update for MsalService methods? This PR is intended to address #4387.

@Shirshaw64p
Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds missing JSDoc on MsalService public methods in @azure/msal-angular to improve generated API reference documentation and address #4387, without changing runtime behavior.

Changes:

  • Added JSDoc for core MsalService auth/token methods (initialize, acquireToken*, login*, logout*, ssoSilent).
  • Added JSDoc for setLogger to improve logging API docs.

Comment thread lib/msal-angular/src/msal.service.ts Outdated
Comment thread lib/msal-angular/src/msal.service.ts
@Shirshaw64p
Copy link
Copy Markdown
Author

Addressed Copilot feedback in latest commit:

  • Clarified setLogger JSDoc to accurately describe cloned logger behavior for msal-angular vs original logger usage in msal-browser.
  • Added required Beachball changefile for @azure/msal-angular with patch change type.

Please re-check when convenient.

@microsoft-github-policy-service
Copy link
Copy Markdown
Contributor

Reminder: This PR appears to be stale. If this PR is still a work in progress please mark as draft.

@microsoft-github-policy-service microsoft-github-policy-service Bot added the Needs: Attention 👋 Awaiting response from the MSAL.js team label May 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs: Attention 👋 Awaiting response from the MSAL.js team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants