Update JavaDoc by sangonzal · Pull Request #74 · AzureAD/microsoft-authentication-library-for-java

sangonzal · 2019-06-27T22:49:04Z

Updating reference documentation

henrik-me · 2019-06-28T05:29:35Z

src/main/java/com/microsoft/aad/msal4j/Account.java


+/**
+ * Representation of a single user account. If modifying this object, ensure it is compliant with
+ * cache persistent model


should this be in the public docs? That seems like an internal comment?

Removed comment

henrik-me · 2019-06-28T05:30:20Z

src/main/java/com/microsoft/aad/msal4j/AppMetadataCacheEntity.java

 import java.util.List;

+/**
+ * Representation of application metadata.


Representation of [](start = 3, length = 18)

Generally not sure this makes a lot of sense. What is this metadata about?

Just has foci status. Not a public API, so removing java doc comment.

henrik-me · 2019-06-28T05:31:18Z

src/main/java/com/microsoft/aad/msal4j/ConfidentialClientApplication.java


+/**
+ * Class to be used to acquire tokens for confidential client applications (Web Apps, Web APIs,
+ * and daemon applications).


should have an aka.ms link that points to the wiki or public docs describing the confidential client

Added links to the Java wiki in both PCA and CCA files.

henrik-me · 2019-06-28T05:32:42Z

JM, would be great to get your comments on this

henrik-me · 2019-06-28T05:33:23Z

// THE SOFTWARE.

nit: consider moving to the short versions of this.

Refers to: src/main/java/com/microsoft/aad/msal4j/UserAssertion.java:22 in 0ff475b. [](commit_id = 0ff475b, deletion_comment = False)

jmprieur · 2019-06-28T17:28:03Z

@sangonzal @henrik-me : I'll have a look at it, but I don't want to be the limiting factor.
Would that work if I proposed a PR later when I have time to look at it (maybe after you have merged, @sangonzal ) ?

sangonzal · 2019-07-01T18:13:01Z

@sangonzal @henrik-me : I'll have a look at it, but I don't want to be the limiting factor.
Would that work if I proposed a PR later when I have time to look at it (maybe after you have merged, @sangonzal ) ?

@jmprieur That works for me, Jean-marc. I will merge these changes in for now, and we can continue to improve the java docs incrementally.

SomkaPe · 2019-07-01T22:42:21Z

src/main/java/com/microsoft/aad/msal4j/DeviceCode.java


    /**
-     *  @return user code.
+     * code which user needs to provide when authenticating at he verification URI


"he" -> the

SomkaPe · 2019-07-01T22:48:39Z

src/main/java/com/microsoft/aad/msal4j/IConfidentialClientApplication.java

-     * Token and the Access Token's expiration time. Refresh Token
-     * property will be null for this overload.
+     * Acquires tokens from the authority configured in the application, for the confidential client
+     * itself (in the name of no user)


"in the name of no user" sounds weird ... like it was said by Master Yoda from Start Wars ))

SomkaPe · 2019-07-01T22:51:25Z

src/main/java/com/microsoft/aad/msal4j/ITokenCacheAccessContext.java


 /**
- * Contains parameters used by the MSAL to access the cache_data.
+ * Interface representing state of token cache


not sure about "state of the cache" - more like context of accessing cache

SomkaPe · 2019-07-01T23:06:55Z

src/main/java/com/microsoft/aad/msal4j/IUserAssertion.java

 package com.microsoft.aad.msal4j;

+/**
+ * Interface representing user credential used by downstream application in On-Behalf-Of flow


I would describe it as - Interface representing delegated user identity and permissions used to propagate it through the request chain in On-Behalf-Of flow.

SomkaPe · 2019-07-01T23:10:18Z

src/main/java/com/microsoft/aad/msal4j/TokenCacheAccessContext.java

 import lombok.experimental.Accessors;

+/**
+ * State of token cache


not sure about "state", more access context

SomkaPe · 2019-07-01T23:11:05Z

src/main/java/com/microsoft/aad/msal4j/UserAssertion.java


 /***
- * Credential type containing an assertion representing user credential.
+ * Credential type containing an assertion representing user credential. Used as a parameter in


same comment as for interface

Update JavaDoc

0ff475b

sangonzal requested review from SomkaPe, henrik-me and jmprieur June 27, 2019 22:49

henrik-me reviewed Jun 28, 2019

View reviewed changes

PR feedback. Update license headers

84d4e16

SomkaPe reviewed Jul 1, 2019

View reviewed changes

PR feedback round 2

c28f032

sangonzal merged commit 57040db into dev Jul 10, 2019

sangonzal mentioned this pull request Jul 12, 2019

Improve reference documentation #60

Closed

sangonzal deleted the sagonzal/javadoc branch July 12, 2019 17:54

Conversation

sangonzal commented Jun 27, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

henrik-me commented Jun 28, 2019

Uh oh!

henrik-me commented Jun 28, 2019

Uh oh!

jmprieur commented Jun 28, 2019

Uh oh!

sangonzal commented Jul 1, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SomkaPe Jul 1, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sangonzal commented Jul 1, 2019 •

edited

Loading

SomkaPe Jul 1, 2019 •

edited

Loading