GH-121 fixing the javadocs

events_mgmt/src/main/java/com/adobe/aio/event/management/ProviderService.java

@@ -52,7 +52,8 @@ public interface ProviderService {
 
   /**
    *
-   * @param instanceId
+   * @param instanceId the AIO Events Provider instance identifier (either chosen by the user or generated by AIO Events backend),
+   *                   note the triple (provider_metadata_id, instanceId, imsOrgId) is unique
    * @return the `Custom Events` Provider associated with the provided instanceId
    */
   Optional<Provider> findCustomEventsProviderByInstanceId(String instanceId);
@@ -61,7 +62,8 @@ public interface ProviderService {
    *
    * @param providerMetadataId indicating the type of provider, if you are interested in
    *                          `Custom Events`provider use findCustomEventsProviderByInstanceId
-   * @param instanceId
+   * @param instanceId the AIO Events Provider instance identifier (either chosen by the user or generated by AIO Events backend),
+   *    *              note the triple (provider_metadata_id, instanceId, imsOrgId) is unique
    * @return the providers list matching the provided criteria and with non-empty event metadata list
    * @see #findCustomEventsProviderByInstanceId(String)
    */

events_mgmt/src/main/java/com/adobe/aio/event/management/model/Provider.java

@@ -138,7 +138,7 @@ public String getProviderMetadata() {
    * @return the Event Delivery Format, either: the old legacy`adobe_io` format
    * or better `cloud_events_v1` (see https://github.com/cloudevents/spec/blob/v1.0/spec.md),
    * @see ProviderInputModel#DELIVERY_FORMAT_ADOBE_IO
-   * @see ProviderInputModel##DELIVERY_FORMAT_CLOUD_EVENTS_V1
+   * @see ProviderInputModel#DELIVERY_FORMAT_CLOUD_EVENTS_V1
    */
   public String getEventDeliveryFormat() {
     return eventDeliveryFormat;

events_mgmt/src/main/java/com/adobe/aio/event/management/model/ProviderInputModel.java

@@ -30,11 +30,11 @@
 public class ProviderInputModel {
 
   /**
-   * Default legacy Adobe I/O Event envelope format (`event_id` --> UUID and `event` --> payload)
+   * Default legacy Adobe I/O Events envelope format
    */
   public static final String DELIVERY_FORMAT_ADOBE_IO = "adobe_io";
   /**
-   * CloudEvents V1 Event envelop format see https://github.com/cloudevents/spec/blob/v1.0/spec.md
+   * CloudEvents V1 envelop format see https://github.com/cloudevents/spec/blob/v1.0/spec.md
    */
   public static final String DELIVERY_FORMAT_CLOUD_EVENTS_V1 = "cloud_events_v1";
 

ims/src/main/java/com/adobe/aio/ims/util/PrivateKeyBuilder.java

@@ -42,7 +42,8 @@ public PrivateKeyBuilder systemEnv() {
   }
 
   /**
-   * will first look on the file system, if not found, in the classpath
+   * @param configPath: will first look on the file system, if not found, in the classpath
+   * @return a PrivateKeyBuilder loaded with the provided config
    */
   public PrivateKeyBuilder configPath(String configPath) throws IOException {
     this.configMap = getMapFromProperties(

src/doc/resources/index.md

@@ -1,24 +1,13 @@
 ## Adobe I/O - Java SDK
 
-This SDK is composed of a few Java Libraries :
-* `aio-lib-java-core`  holds the core models, builders, utilities used across the other libraries below,
-* `aio-lib-java-ims` is a library wrapping a subset of [Adobe Identity Management System (IMS) API](https://www.adobe.io/authentication/auth-methods.html#!AdobeDocs/adobeio-auth/master/AuthenticationOverview/AuthenticationGuide.md)
-* `aio-lib-java-events-mgmt` is a library wrapping [Adobe I/O Events Provider and Registration API](https://www.adobe.io/apis/experienceplatform/events/docs.html#!adobedocs/adobeio-events/master/api/api.md)
-* `aio-lib-java-events-ingress` is a library wrapping [Adobe I/O Events Publishing API](https://www.adobe.io/apis/experienceplatform/events/docs.html#!adobedocs/adobeio-events/master/api/eventsingress_api.md)
-* `aio-lib-java-events-journal` is a library wrapping [Adobe I/O Events Journaling API](https://www.adobe.io/apis/experienceplatform/events/docs.html#!adobedocs/adobeio-events/master/api/journaling_api.md)
-* as well as `aem` a sub-module, home of various [Adobe I/O Events and AEM osgi connectors and packages](https://developer.adobe.com/events/docs/guides/using/aem/)
-
-### Maven Dependency
-
-Include via Maven:
-
-Example:
-```
-<dependency>
-    <groupId>com.adobe.aio</groupId>
-    <artifactId>aio-lib-java-ims</artifactId>
-    <version>${project.version}</version>
-</dependency>
-```
+This SDK is composed of a few Java Libraries:
+* [`aio-lib-java-core`](https://github.com/adobe/aio-lib-java/tree/main/core) holds the core models, builders, utilities used across the other libraries below,
+* [`aio-lib-java-ims`](https://github.com/adobe/aio-lib-java/tree/main/ims) is a library wrapping a subset of [Adobe Identity Management System (IMS) API](https://www.adobe.io/authentication/auth-methods.html#!AdobeDocs/adobeio-auth/master/AuthenticationOverview/AuthenticationGuide.md)
+* [`aio-lib-java-events-mgmt`](https://github.com/adobe/aio-lib-java/tree/main/events_mgmt) is a library wrapping [Adobe I/O Events Provider and Registration API](https://www.adobe.io/apis/experienceplatform/events/docs.html#!adobedocs/adobeio-events/master/api/api.md)
+* [`aio-lib-java-events-ingress`](https://github.com/adobe/aio-lib-java/tree/main/events_ingress) is a library wrapping [Adobe I/O Events Publishing API](https://www.adobe.io/apis/experienceplatform/events/docs.html#!adobedocs/adobeio-events/master/api/eventsingress_api.md)
+* [`aio-lib-java-events-journal`](https://github.com/adobe/aio-lib-java/tree/main/events_journal) is a library wrapping [Adobe I/O Events Journaling API](https://www.adobe.io/apis/experienceplatform/events/docs.html#!adobedocs/adobeio-events/master/api/journaling_api.md)
+* as well as [`aem`](https://github.com/adobe/aio-lib-java/tree/main/aem) a sub-module, home of various [Adobe I/O Events and AEM osgi connectors and packages](https://developer.adobe.com/events/docs/guides/using/aem/)
+
+### JavaDocs
 
 See the [JavaDocs](https://opensource.adobe.com/aio-lib-java/apidocs/) for the API.