Skip to content

doc(oauth2): name the constructor parameter these classes actually take - #16336

Open
karpovantonme wants to merge 1 commit into
googleapis:mainfrom
karpovantonme:doc-oauth2-client-factory
Open

doc(oauth2): name the constructor parameter these classes actually take#16336
karpovantonme wants to merge 1 commit into
googleapis:mainfrom
karpovantonme:doc-oauth2-client-factory

Conversation

@karpovantonme

Copy link
Copy Markdown

Four credential constructors document parameters they do not take:

/**
 * Creates an instance of AuthorizedUserCredentials.
 *
 * @param rest_client a dependency injection point. It makes it possible to
 *     mock internal REST types. This should generally not be overridden
 *     except for testing.
 */
explicit AuthorizedUserCredentials(AuthorizedUserCredentialsInfo info,
                                   Options options,
                                   HttpClientFactory client_factory);

rest_client is gone, and so is current_time_fn in the other two. The injection point they describe is now client_factory, so Doxygen drops the description as belonging to nothing and the parameter that is actually there ends up undocumented.

Same shape in AuthorizedUserCredentials, ComputeEngineCredentials, ImpersonateServiceAccountCredentials and ServiceAccountCredentials. Renamed the names, kept the wording each file already used, no behaviour touched.

The four credential constructors document a rest_client and a current_time_fn.
Neither has existed since the client factory replaced them, so Doxygen drops
the description and client_factory is left undocumented.
@karpovantonme
karpovantonme requested a review from a team as a code owner August 7, 2026 22:30

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates the Doxygen documentation across several OAuth2 credentials header files to reflect the transition from using rest_client or current_time_fn parameters to client_factory. There are no review comments, and I have no feedback to provide.

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.

1 participant