Skip to content

Update JavaDoc comments#181

Merged
sangonzal merged 2 commits intodevfrom
sagonzal/updateJavaDoc
Feb 21, 2020
Merged

Update JavaDoc comments#181
sangonzal merged 2 commits intodevfrom
sagonzal/updateJavaDoc

Conversation

@sangonzal
Copy link
Copy Markdown
Contributor

#169 and #75

Copy link
Copy Markdown
Contributor

@navyasric navyasric left a comment

Choose a reason for hiding this comment

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

Looks good. I have left some comments to update aks.ms links to point to docs.


/**
* Authorization code acquired in the first step of OAuth2.0 authorization code flow. For more
* details, see https://aka.ms/msal4j-authorization-code-flow
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/**
* In the context of device code user has not yet authenticated via browser
* In the context of device code user has not yet authenticated via browser. For more details,
* see https://aka.ms/msal4j-device-code
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/**
* Factory for creating client credentials used in confidential client flows
* Factory for creating client credentials used in confidential client flows. For more details, see
* https://aka.ms/msal4j-client-credentials
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The docs link you're pointing to doesn't say anything about ClientCredentialFactory (how to initialize a client credential for confidential clients). The wiki page is more useful.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Based on the new patterns in the dev samples, we are going to update docs pages. We can probably update the links once the docs pages are updated.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sounds good, I'm fine with that.

* Object containing parameters for Username/Password flow. Can be used as parameter to
* {@link PublicClientApplication#acquireToken(UserNamePasswordParameters)}
*
* For more details, see https://aka.ms/msal4j-username-password
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@sangonzal
Copy link
Copy Markdown
Contributor Author

sangonzal commented Feb 21, 2020

@navyasric Thanks for reviewing. Yes I plan on changing the redirect links to point to the microsoft docs (other than the client-credentials link) when we update the code snippets. We can update the links at any time on https://aka.ms. I've added the DevexJavaPython security group to the owners for all of these links btw, so any of us can update them at any point

@sangonzal sangonzal merged commit f0752b3 into dev Feb 21, 2020
@sangonzal sangonzal deleted the sagonzal/updateJavaDoc branch February 12, 2021 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants