Fix documentation problems

nevermined-io · Dec 11, 2020 · 77ecb4c · 77ecb4c
1 parent 872c37a
commit 77ecb4c
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 38 deletions.
diff --git a/src/main/java/io/keyko/nevermined/external/GatewayService.java b/src/main/java/io/keyko/nevermined/external/GatewayService.java
@@ -554,7 +554,7 @@ public static ComputeStatus getComputeStatus(String serviceEndpoint, String cons
      * @param serviceEndpoint The endpoint of the service. We need this to retrieve the gateway host and port.
      * @param grantToken      The Grant Token generated by the user.
      * @return AccessTokenResult
-     * @throws ServiceException
+     * @throws ServiceException ServiceException
      */
     public static AccessTokenResult getAccessToken(String serviceEndpoint, String grantToken) throws ServiceException {
         ArrayList<NameValuePair> list = new ArrayList<NameValuePair>();
@@ -605,7 +605,7 @@ public static AccessTokenResult getAccessToken(String serviceEndpoint, String gr
      *
      * @param bodyResponse The body of the HTTP response
      * @return String The access token.
-     * @throws IOException
+     * @throws IOException IOException
      */
     private static String getAccessTokenFromBody(String bodyResponse) throws IOException {
         ObjectMapper mapper = new ObjectMapper();

diff --git a/src/main/java/io/keyko/nevermined/manager/BaseManager.java b/src/main/java/io/keyko/nevermined/manager/BaseManager.java
@@ -570,12 +570,12 @@ public String generateSignature(String message) throws IOException, CipherExcept
     /**
      * Generate the Grant Token for the Access service.
      *
-     * @param serviceAgreementId
-     * @param did
+     * @param serviceAgreementId The Service Agreement Id.
+     * @param did The did.
      * @return String The Grant Token.
-     * @throws CryptoException
-     * @throws IOException
-     * @throws CipherException
+     * @throws CryptoException CryptoException
+     * @throws IOException IOException
+     * @throws CipherException CipherException
      */
     public String generateAccessGrantToken(String serviceAgreementId, DID did)
             throws CryptoException, IOException, CipherException {
@@ -585,11 +585,11 @@ public String generateAccessGrantToken(String serviceAgreementId, DID did)
     /**
      * Generat the Grant Token for the Download service.
      *
-     * @param did
+     * @param did The did.
      * @return String The Grant Token.
-     * @throws CryptoException
-     * @throws IOException
-     * @throws CipherException
+     * @throws CryptoException CryptoException
+     * @throws IOException IOExcception
+     * @throws CipherException CipherException
      */
     public String generateDownloadGrantToken(DID did) throws CryptoException, IOException, CipherException {
         return JwtHelper.generateDownloadGrantToken(getKeeperService().getCredentials(), did.getDid());
@@ -598,12 +598,12 @@ public String generateDownloadGrantToken(DID did) throws CryptoException, IOExce
     /**
      * Generate the Grant Token for the Execute service.
      *
-     * @param serviceAgreementId
-     * @param workflowDid
+     * @param serviceAgreementId The Service Agreement Id.
+     * @param workflowDid The workflow did.
      * @return String The Grant Token.
-     * @throws CryptoException
-     * @throws IOException
-     * @throws CipherException
+     * @throws CryptoException CryptoException
+     * @throws IOException IOException
+     * @throws CipherException CipherException
      */
     public String generateExecuteGrantToken(String serviceAgreementId, DID workflowDid)
             throws CryptoException, IOException, CipherException {
@@ -613,12 +613,12 @@ public String generateExecuteGrantToken(String serviceAgreementId, DID workflowD
     /**
      * Generate the Grant Token for the Compute service.
      *
-     * @param serviceAgreementId
-     * @param executionId
+     * @param serviceAgreementId The Service Agreement Id.
+     * @param executionId The excution Id of the compute job.
      * @return String The Grant Token.
-     * @throws CryptoException
-     * @throws IOException
-     * @throws CipherException
+     * @throws CryptoException CryptoException
+     * @throws IOException IOException
+     * @throws CipherException CipherException
      */
     public String generateComputeGrantToken(String serviceAgreementId, String executionId)
             throws CryptoException, IOException, CipherException {

diff --git a/src/main/java/io/keyko/nevermined/manager/NeverminedManager.java b/src/main/java/io/keyko/nevermined/manager/NeverminedManager.java
@@ -1044,7 +1044,7 @@ public InputStream consumeBinary(String serviceAgreementId, DID did, int service
     /**
      * Executes a remote service associated with an asset and serviceAgreementId
      *
-     * @param agreementId the agreement id
+     * @param serviceAgreementId the agreement id
      * @param did         the did
      * @param index       the index of the service
      * @param workflowDID the workflow id
@@ -1130,10 +1130,10 @@ public ComputeStatus getComputeStatus(String serviceAgreementId, String executio
      *  - makes a call to the gateway to fetch the access token
      *  - caches the token
      *
-     * @param serviceEndpoint
-     * @param did
+     * @param serviceEndpoint The endpoint of the service.
+     * @param did The did.
      * @return String The Access Token.
-     * @throws ConsumeServiceException
+     * @throws ConsumeServiceException ConsumeServiceException
      */
     private String getDownloadAccessToken(String serviceEndpoint, DID did) throws ConsumeServiceException {
         // Check if token is cached
@@ -1182,11 +1182,11 @@ private String getDownloadAccessToken(String serviceEndpoint, DID did) throws Co
      *  - makes a call to the gateway to fetch the access token
      *  - caches the token
      *
-     * @param serviceEndpoint
-     * @param serviceAgreementId
-     * @param did
+     * @param serviceEndpoint The service endpoint.
+     * @param serviceAgreementId The Service Agreement Id.
+     * @param did The did.
      * @return String The Access Token.
-     * @throws ConsumeServiceException
+     * @throws ConsumeServiceException ConsumeServiceException
      */
     private String getAccessAccessToken(String serviceEndpoint, String serviceAgreementId, DID did)
             throws ConsumeServiceException {
@@ -1237,11 +1237,11 @@ private String getAccessAccessToken(String serviceEndpoint, String serviceAgreem
      *  - makes a call to the gateway to fetch the access token
      *  - caches the token
      *
-     * @param serviceEndpoint
-     * @param serviceAgreementId
-     * @param workflowDID
+     * @param serviceEndpoint The service endpoint.
+     * @param serviceAgreementId The Service Agreement Id.
+     * @param workflowDID The workflow did.
      * @return String The Access Token.
-     * @throws ServiceException
+     * @throws ServiceException ServiceException
      */
     private String getExecuteAccessToken(String serviceEndpoint, String serviceAgreementId, DID workflowDID)
             throws ServiceException {
@@ -1292,11 +1292,11 @@ private String getExecuteAccessToken(String serviceEndpoint, String serviceAgree
      *  - makes a call to the gateway to fetch the access token
      *  - caches the token
      *
-     * @param serviceEndpoint
-     * @param serviceAgreementId
-     * @param executionId
+     * @param serviceEndpoint The service endpoint.
+     * @param serviceAgreementId The Service Agreement Id.
+     * @param executionId The execution Id.
      * @return String The Access Token.
-     * @throws ServiceException
+     * @throws ServiceException ServiceException
      */
     private String getComputeAccessToken(String serviceEndpoint, String serviceAgreementId, String executionId)
             throws ServiceException {
@@ -1344,7 +1344,7 @@ private String getComputeAccessToken(String serviceEndpoint, String serviceAgree
      *
      * This key will be used to search the token cache.
      *
-     * @param args
+     * @param args List of arguments.
      * @return String The cache key.
      */
     private String getCacheKey(String ... args) {