From 7839467360358b4ef3977ebacfe7699cfeb59bb4 Mon Sep 17 00:00:00 2001 From: zubri Date: Mon, 2 Nov 2020 14:00:57 -0300 Subject: [PATCH] fixed javadoc jar --- CHANGELOG.txt | 3 +++ build.gradle | 21 ++++++++++++++++++++- overview.html | 26 +++++++++++++++----------- 3 files changed, 38 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index ec4980a22..6a1799aa4 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -2,6 +2,9 @@ Prowide ISO 20022 - CHANGELOG ----------------------------------------------------------------------------------------------------------------------- +RELEASE 9.1.4 - November 2020 + * Fixed javadoc jar + RELEASE 9.1.3 - October 2020 * Fixed pom file diff --git a/build.gradle b/build.gradle index 75d9d655d..6239d1d55 100644 --- a/build.gradle +++ b/build.gradle @@ -5,7 +5,7 @@ apply plugin: 'maven' def SRU = "2020" -version = "SRU${SRU}-9.1.3" +version = "SRU${SRU}-9.1.4" group 'com.prowidesoftware' sourceCompatibility = '1.8' @@ -150,18 +150,37 @@ def formattedDate() { new Date().format('dd MMM yyyy') } +//task aggregatedJavadoc(type: Javadoc) { javadoc { + group = 'Documentation' + description = 'Generate javadocs from all child projects as if it was a single project' + failOnError false + destinationDir = file("$buildDir/docs/javadoc") + options.overview = "overview.html" options.header = "${version}" options.windowTitle = "Prowide ISO 20022 API Reference" + title = "Prowide ISO 20022 API Reference" options.footer="SRU${SRU}, generated ${formattedDate()}" + options.author false + options.links 'http://docs.oracle.com/javase/8/docs/api/' + options.addStringOption 'Xdoclint:none', '-quiet' // this will fail when the option is not available (older JDK) options.addBooleanOption("-allow-script-in-comments", true) options.bottom = '' exclude "**/dic/**" + + subprojects.each { proj -> + proj.tasks.withType(Javadoc).each { javadocTask -> + source += javadocTask.source + classpath += javadocTask.classpath + excludes += javadocTask.excludes + includes += javadocTask.includes + } + } } task writePom { diff --git a/overview.html b/overview.html index dae503ef1..a61e7ff6c 100644 --- a/overview.html +++ b/overview.html @@ -2,14 +2,13 @@

Prowide ISO 20022

-

The Prowide ISO 20022 library implements the foundation classes to manage ​ISO 20022 (MX)​ messages in Java

-

This library is part of the Prowide Core open source project.

+ The Prowide ISO 20022 library implements the foundation classes to manage ISO 20022 (MX) messages in Java

The scope of this javadoc is the features distributed in the pw-iso20022-SRUYYYY-version.jar

-

This library provides a comprehensive model for all ISO 20022 message categories. The API features include - parsing messages from XML format to Java, serializing Java model objects into the XML format and the conversion - between ISO messages and JSON.

+

This library provides a comprehensive parser and model for all ISO 20022 message categories. The API features + include parsing messages from XML format to Java, serializing Java model objects into the XML format and the + conversion between ISO messages and JSON.

The library implements the general ISO 20022 standard. Complementary packages with restricted ISO versions such as SEPA, and CBPR+ are provided in the complementary, proprietary (not open source) library Prowide Integrator.

@@ -17,14 +16,19 @@

This library is part of the Prowide Core open source project.

This library is based on some components from the Prowide Core base library. So in order to use this, you will need also the dependency for the pw-swift-core jar.

-

MX classes are split in two fundamental packages:

+

MX classes are split in two main packages:

  1. com.prowidesoftware.swift.mx.model.dic: which contains all dictionary classes, in other words, classes representing business entities which are used inside MX messages. Due to the large number of - classes in this package, it is excluded from the generated javadoc.
    2. -
  2. com.prowidesoftware.swift.mx.model: which contains classes that represent MX messages
    3. + classes in this package, it is excluded from the generated javadoc. This model objects are simple + POJO implementations for each element within an ISO 20022 messages. The key feature of the generated + model is that business dictionary elements are shared across all message types + (they are not coupled to any specific namespace). + +
  3. com.prowidesoftware.swift.mx.model: which contains classes that represent MX messages and provides + the entry point to parse, build or serialize a message.
-

The sys subpackage includes classes for the system messages.

+

The sys subpackage includes classes for the MX system messages.

Creating MX messages

@@ -41,8 +45,8 @@ 
Parsing MX messages

 
 	
Additional resources

 	
    
-		
  1. Prowide Core resources: http://www.prowidesoftware.com/resources
    2. 
-		
  2. Prowide Code examples: https://github.com/prowide/prowide-core-examples
    3. 
+		
  3. http://www.prowidesoftware.com/resources
    4. 
+		
  4. https://github.com/prowide/prowide-iso20022-examples
    5. 
 	

 
 	

For ISO 20022 messages validation, SEPA, CBPR+, TARGET2 and other restricted ISO versions, please check the Integrator version at http://www.prowidesoftware.com/products/integrator