javadoc fixes

oehf · Dec 27, 2024 · 62a16ae · 62a16ae
1 parent 3720af7
commit 62a16ae
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 19 deletions.
diff --git a/...audit/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti81/Iti81ResourceProvider.java b/...audit/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti81/Iti81ResourceProvider.java
@@ -39,7 +39,9 @@
 
 /**
  * According to the Restful ATNA specification, this resource provider must handle requests in the form
- * GET [base]/AuditEvent?date=>start-time&date=<stoptime>&<query>{&_format=[mime-type]}
+ * <pre>
+ * GET [base]/AuditEvent?date=starttime&amp;date=stoptime&amp;query{&amp;_format=[mime-type]}
+ * </pre>
  *
  * @author Christian Ohr
  * @since 3.6

diff --git a/...ixpdq/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti83/Iti83ResourceProvider.java b/...ixpdq/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti83/Iti83ResourceProvider.java
@@ -41,7 +41,9 @@
 
 /**
  * According to the PIXM specification, this resource provider must handle requests in the form
- * GET [base]/Patient/$ihe-pix?sourceIdentifier=[token]]{&targetSystem=[uri]}{&_format=[mime-type]}
+ * <pre>
+ * GET [base]/Patient/$ihe-pix?sourceIdentifier=[token]]{&amp;targetSystem=[uri]}{&amp;_format=[mime-type]}
+ * </pre>
  *
  * @author Christian Ohr
  * @since 3.6

diff --git a/...ihe/xds/src/main/java/org/openehealth/ipf/commons/ihe/xds/core/audit/XdsAuditDataset.java b/...ihe/xds/src/main/java/org/openehealth/ipf/commons/ihe/xds/core/audit/XdsAuditDataset.java
@@ -42,7 +42,7 @@ public XdsAuditDataset(boolean serverSide) {
     }
 
     /**
-     * @return the first present patient ID as HL7 CX string, e.g. "1234^^^&1.2.3.4&ISO",
+     * @return the first present patient ID as HL7 CX string, e.g. "1234^^^&amp;1.2.3.4&amp;ISO",
      * or the patient ID extracted from XUA token,
      * or <code>null</code> when no patient IDs have been collected.
      */

diff --git a/...openehealth/ipf/commons/ihe/xds/core/stub/xdsi/RetrieveImagingDocumentSetRequestType.java b/...openehealth/ipf/commons/ihe/xds/core/stub/xdsi/RetrieveImagingDocumentSetRequestType.java
@@ -63,7 +63,7 @@
  *            &lt;xs:sequence>
  *              &lt;xs:element name="TransferSyntaxUID" type="rim:LongName" maxOccurs="unbounded">
  *                &lt;xs:annotation>
- *                   &lt;xs:documentation>This is the list of DICOM transfer syntax UIDs to be used when requesting retrieval of DICOM images</xs:documentation>
+ *                   &lt;xs:documentation>This is the list of DICOM transfer syntax UIDs to be used when requesting retrieval of DICOM images&lt;/xs:documentation>
  *                &lt;/xs:annotation>
  *              &lt;/xs:element>
  *            &lt;/xs:sequence>
@@ -230,7 +230,7 @@ public List<SeriesRequest> getSeriesRequest() {
      *     &lt;xs:sequence>
      *       &lt;xs:element name="TransferSyntaxUID" type="rim:LongName" maxOccurs="unbounded">
      *         &lt;xs:annotation>
-     *           &lt;xs:documentation>This is the list of DICOM transfer syntax UIDs to be used when requesting retrieval of DICOM images</xs:documentation>
+     *           &lt;xs:documentation>This is the list of DICOM transfer syntax UIDs to be used when requesting retrieval of DICOM images&lt;/xs:documentation>
      *         &lt;/xs:annotation>
      *       &lt;/xs:element>
      *     &lt;/xs:sequence>

diff --git a/...s/spring/src/main/java/org/openehealth/ipf/commons/spring/core/config/SpringRegistry.java b/...s/spring/src/main/java/org/openehealth/ipf/commons/spring/core/config/SpringRegistry.java
@@ -36,9 +36,11 @@
  * </p>
  * or, even easier, using the globalContext tag in the
  * http://openehealth.org/schema/ipf-commons-core extension namespace:
+ *
  * <pre>
- *     <ipf-commons-core:globalContext/>
+ *     &lt;ipf-commons-core:globalContext/>
  * </pre>
+ *
  * Then the "stateful" Groovy Extension Modules will access the Spring
  * registry.
  *

diff --git a/.../java/org/openehealth/ipf/platform/camel/ihe/continua/hrn/ContinuaHrnCamelProcessors.java b/.../java/org/openehealth/ipf/platform/camel/ihe/continua/hrn/ContinuaHrnCamelProcessors.java
@@ -84,7 +84,7 @@ private static Source getSource(byte[] bytes) {
 
 
     /**
-     * Returns a transformation & validation processor for Continua HRN request messages.
+     * Returns a transformation and validation processor for Continua HRN request messages.
      * The HRN request contained in the exchange will be translated into IPF simplified
      * XDS message model and enriched with CDA document content.
      */

diff --git a/...el/ihe/ws/src/main/java/org/openehealth/ipf/platform/camel/ihe/ws/AbstractWsProducer.java b/...el/ihe/ws/src/main/java/org/openehealth/ipf/platform/camel/ihe/ws/AbstractWsProducer.java
@@ -211,7 +211,7 @@ public AbstractWsEndpoint<AuditDatasetType, ConfigType> getEndpoint() {
 
 
     /**
-     * Sets thread safety & timeout options of the given CXF client.
+     * Sets thread safety and timeout options of the given CXF client.
      */
     protected void configureClient(Object o) {
         var client = (ClientImpl) ClientProxy.getClient(o);

diff --git a/pom.xml b/pom.xml
@@ -29,7 +29,7 @@
 
         <surefire-plugin-version>3.5.2</surefire-plugin-version>
         <jxr-plugin-version>3.6.0</jxr-plugin-version>
-        <project-info-reports-plugin-version>3.5.0</project-info-reports-plugin-version>
+        <project-info-reports-plugin-version>3.8.0</project-info-reports-plugin-version>
         <maven-dsldoc-plugin-version>1.6</maven-dsldoc-plugin-version>
         <maven-changes-plugin-version>2.12.1</maven-changes-plugin-version>
 
@@ -355,10 +355,35 @@
                         <excludePackageNames>*.tutorials,*.test</excludePackageNames>
                         <additionalJOption>-J-Xmx2048m</additionalJOption>
                         <doclint>none</doclint>
+                        <groups>
+                            <group>
+                                <title>Common (non-Camel) classes</title>
+                                <packages>org.openehealth.ipf.commons*</packages>
+                            </group>
+                            <group>
+                                <title>HL7 and CDA Modules</title>
+                                <packages>org.openehealth.ipf.modules*</packages>
+                            </group>
+                            <group>
+                                <title>Camel component classes</title>
+                                <packages>org.openehealth.ipf.platform.camel*</packages>
+                            </group>
+                            <group>
+                                <title>Spring Boot integration</title>
+                                <packages>org.openehealth.ipf.boot*</packages>
+                            </group>
+                            <group>
+                                <title>Tutorials and Examples</title>
+                                <packages>org.openehealth.ipf.tutorials*</packages>
+                            </group>
+                            <group>
+                                <title>Other</title>
+                                <packages>net.ihe.gazelle*:ca.uhn.hl7v2*</packages>
+                            </group>
+                        </groups>
                         <!-- stupid: javadoc:aggregate cannot resolve relative sourcepaths -->
                         <sourcepath>
                             boot/ipf-atna-spring-boot-starter/generated-stubs:
-                            boot/ipf-fhir-stu3-spring-boot-starter/generated-stubs:
                             boot/ipf-fhir-r4-spring-boot-starter/generated-stubs:
                             boot/ipf-hl7-spring-boot-starter/generated-stubs:
                             boot/ipf-hl7v3-spring-boot-starter/generated-stubs:
@@ -370,11 +395,6 @@
                             commons/core/generated-stubs:
                             commons/ihe/core/generated-stubs:
                             commons/ihe/fhir/core/generated-stubs:
-                            commons/ihe/fhir/stu3/core/generated-stubs:
-                            commons/ihe/fhir/stu3/audit/generated-stubs:
-                            commons/ihe/fhir/stu3/mhd/generated-stubs:
-                            commons/ihe/fhir/stu3/pixpdq/generated-stubs:
-                            commons/ihe/fhir/stu3/qedm/generated-stubs:
                             commons/ihe/fhir/r4/core/generated-stubs:
                             commons/ihe/fhir/r4/audit/generated-stubs:
                             commons/ihe/fhir/r4/chppqm/generated-stubs:
@@ -403,10 +423,6 @@
                             platform-camel/ihe/continua/generated-stubs:
                             platform-camel/ihe/core/generated-stubs:
                             platform-camel/ihe/fhir/core/generated-stubs:
-                            platform-camel/ihe/fhir/stu3/audit/generated-stubs:
-                            platform-camel/ihe/fhir/stu3/mhd/generated-stubs:
-                            platform-camel/ihe/fhir/stu3/pixpdq/generated-stubs:
-                            platform-camel/ihe/fhir/stu3/qedm/generated-stubs:
                             platform-camel/ihe/fhir/r4/audit/generated-stubs:
                             platform-camel/ihe/fhir/r4/chppqm/generated-stubs:
                             platform-camel/ihe/fhir/r4/mhd/generated-stubs: