diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..58f755b --- /dev/null +++ b/.yardopts @@ -0,0 +1,3 @@ +--markup markdown +--readme README.md +lib \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 2f70114..97cc593 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ ## [Released] +## [1.3.2] - 2025-10-23 +### Added +- YARD documentation generation support with `.yardopts` configuration +- Added `yard` gem as development dependency for API documentation + +### Fixed +- Fixed YARD link resolution warning in README.md by converting markdown link to HTML format + +### Documentation +- Configured YARD to generate comprehensive API documentation +- Documentation coverage: 70.59% (51 methods, 22 classes, 5 modules) + +**Full Changelog**: https://github.com/Sentia/zai-payment/compare/v1.3.1...v1.3.2 + ## [1.3.1] - 2025-10-23 ### Changed - Update error response format diff --git a/Gemfile b/Gemfile index 6cdffbb..133d689 100644 --- a/Gemfile +++ b/Gemfile @@ -18,4 +18,5 @@ group :development, :test do gem 'rubocop-packaging', require: false gem 'rubocop-performance', require: false gem 'rubocop-rspec', require: false + gem 'yard', '~> 0.9.37', require: false end diff --git a/Gemfile.lock b/Gemfile.lock index 51489e2..4614245 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - zai_payment (1.3.1) + zai_payment (1.3.2) base64 (~> 0.3.0) faraday (~> 2.0) openssl (~> 3.3) @@ -119,6 +119,7 @@ GEM addressable (>= 2.8.0) crack (>= 0.3.2) hashdiff (>= 0.4.0, < 2.0.0) + yard (0.9.37) PLATFORMS arm64-darwin-24 @@ -135,6 +136,7 @@ DEPENDENCIES simplecov vcr webmock + yard (~> 0.9.37) zai_payment! BUNDLED WITH diff --git a/README.md b/README.md index 38a167f..0f3f312 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ token = token_provider.bearer_token The gem handles OAuth2 Client Credentials flow automatically - tokens are cached and refreshed before expiration. -📖 **[Complete Authentication Guide](docs/AUTHENTICATION.md)** - Two approaches, examples, and best practices +📖 **Complete Authentication Guide** - Two approaches, examples, and best practices ### Users diff --git a/lib/zai_payment/version.rb b/lib/zai_payment/version.rb index e85870c..ae7e706 100644 --- a/lib/zai_payment/version.rb +++ b/lib/zai_payment/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ZaiPayment - VERSION = '1.3.1' + VERSION = '1.3.2' end