Skip to content

docs: add class-level Javadoc to BaseClient, CustomCheckoutClient, and SubscriptionClient#46

Open
omghante wants to merge 1 commit into
PhonePe:mainfrom
omghante:docs/45-add-class-level-javadoc
Open

docs: add class-level Javadoc to BaseClient, CustomCheckoutClient, and SubscriptionClient#46
omghante wants to merge 1 commit into
PhonePe:mainfrom
omghante:docs/45-add-class-level-javadoc

Conversation

@omghante

Copy link
Copy Markdown

Description

Add class-level Javadoc to the three client classes that were missing documentation. StandardCheckoutClient already has one this brings the other three to the same standard.

Related Issue

Fixes #45

Changes Made

  • BaseClient: document its role as shared abstract base for OAuth token management, HTTP execution, and event telemetry
  • CustomCheckoutClient: document PCI-compliant card/token routing and device OS header injection
  • SubscriptionClient: document autopay flows (setup, notify, redeem, cancel, status)
  • Added @see cross-references between all client classes

How to Test

  1. Open any of the three classes in an IDE and verify Javadoc tooltip appears on hover

Checklist

  • I have read the CONTRIBUTING.md guide
  • Code follows the project's style guidelines (mvn spotless:apply)
  • Tests added for new functionality (if applicable) — N/A, docs only
  • All tests pass (mvn clean verify)
  • Documentation updated (if applicable)

…d SubscriptionClient

- BaseClient: document its role as shared base for OAuth, HTTP, and telemetry
- CustomCheckoutClient: document PCI routing and device OS handling
- SubscriptionClient: document autopay flows (setup, notify, redeem, cancel)
- Add @see cross-references between all client classes

Fixes PhonePe#45
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.

Add class-level Javadoc to CustomCheckoutClient, SubscriptionClient, and BaseClient

1 participant