Skip to content

Commit

Permalink
Improve javadoc (closes marcwrobel#121)
Browse files Browse the repository at this point in the history
- add examples,
- add documentation on packages,
- add an overview,
- fix javadoc warnings,
- minor improvements and type fixes.
  • Loading branch information
marcwrobel committed Jul 6, 2022
1 parent 04206bc commit deb4e65
Show file tree
Hide file tree
Showing 24 changed files with 454 additions and 181 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

- Update NYSE and New York FED calendars following [Juneteenth National Independence Day Act](https://www.cnbc.com/2021/06/17/juneteenth-federal-holiday-biden-signs-bill.html)
(#98).
- Improve documentation: add examples, documentation on packages, an overview and fix typos (#121).

### Fixed

Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,26 @@ limited to, European banking.

jbanking is supporting the following features :

* [ISO 3166-1 countries](http://wikipedia.org/wiki/ISO_3166-1) (with alpha-2 code, alpha-3 code, numeric code and status
- e.g. independent or dependent according to the [International Organization for Standardization](https://www.iso.org)).
* Countries' or territories' participation to economic agreements :
* [European Economic Area (EEA)](https://wikipedia.org/wiki/European_Economic_Area)
* [European Free Trade Association (EFTA)](https://wikipedia.org/wiki/European_Free_Trade_Association)
* [European Union (EU)](https://en.wikipedia.org/wiki/European_Union)
* [SEPA COM Pacifique](https://www.cfonb.org/Default.aspx?lid=1&rid=122&rvid=239)
* [Single Euro Payments Area (SEPA)](https://wikipedia.org/wiki/Single_Euro_Payments_Area)
* [ISO 3166-1 countries](http://wikipedia.org/wiki/ISO_3166-1) with alpha-2 code, alpha-3 code, numeric code and status,
e.g. independent or dependent (according to the [International Organization for Standardization](https://www.iso.org)).
* Countries or territories participation to economic agreements :
* [European Economic Area (EEA)](https://wikipedia.org/wiki/European_Economic_Area),
* [European Free Trade Association (EFTA)](https://wikipedia.org/wiki/European_Free_Trade_Association),
* [European Union (EU)](https://en.wikipedia.org/wiki/European_Union),
* [SEPA COM Pacifique](https://www.cfonb.org/Default.aspx?lid=1&rid=122&rvid=239),
* [Single Euro Payments Area (SEPA)](https://wikipedia.org/wiki/Single_Euro_Payments_Area).
* [ISO 4217 currencies](http://wikipedia.org/wiki/ISO_4217) (with alphabetic code, numeric code, minor unit and
countries using it).
* [ISO 9362:2009 BIC](http://wikipedia.org/wiki/Bank_Identifier_Code) handling and validation.
* [ISO 13616:2007 IBAN](http://wikipedia.org/wiki/International_Bank_Account_Number) handling and validation (for both
checkdigit and national bank account number structure).
check digit and national bank account number structure).
* [Creditor Identifiers (CIs)](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/creditor-identifier-overview)
handling and validation.
* Configurable [holiday](https://wikipedia.org/wiki/Holiday) calendar support with predefined calendars for :
* Frankfurt, London, Paris, Sydney, and Tokyo financial districts
* Federal Reserve Bank of New York (FED)
* New York Stock Exchange (NYSE)
* European Union TARGET system
* Frankfurt, London, Paris, Sydney, and Tokyo financial districts,
* Federal Reserve Bank of New York (FED),
* New York Stock Exchange (NYSE),
* European Union TARGET system.

## Requirements

Expand Down
Loading

0 comments on commit deb4e65

Please sign in to comment.