From 82ad7204673fa5118b4fa0c8edd2c84a546fd226 Mon Sep 17 00:00:00 2001
From: Jeremy Bernard <jeremy.bernard@iex.ec>
Date: Thu, 22 Jun 2023 13:25:13 +0200
Subject: [PATCH] Update javadoc comments in `PreComputeApp`

---
 src/main/java/com/iexec/worker/tee/pre/PreComputeApp.java | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/src/main/java/com/iexec/worker/tee/pre/PreComputeApp.java b/src/main/java/com/iexec/worker/tee/pre/PreComputeApp.java
index b2c08c9..1e355e3 100644
--- a/src/main/java/com/iexec/worker/tee/pre/PreComputeApp.java
+++ b/src/main/java/com/iexec/worker/tee/pre/PreComputeApp.java
@@ -40,7 +40,7 @@ public PreComputeApp(String chainTaskId) {
      * Download, decrypt, and save the plain dataset file in "/iexec_in".
      * If the decrypted file is an archive, it won't be extracted.
      * 
-     * @throws PreComputeException
+     * @throws PreComputeException if dataset or input files could not be made available for the application enclave
      */
     void run() throws PreComputeException {
         preComputeArgs = PreComputeArgs.readArgs(chainTaskId);
@@ -74,8 +74,7 @@ void checkOutputFolder() throws PreComputeException {
      * Download encrypted dataset file and check its checksum.
      * 
      * @return downloaded file bytes
-     * @throws PreComputeException if download fails or bad file
-     * checksum
+     * @throws PreComputeException if download fails or bad file checksum
      */
     byte[] downloadEncryptedDataset() throws PreComputeException {
         String encryptedDatasetUrl = getPreComputeArgs().getEncryptedDatasetUrl();
@@ -168,7 +167,7 @@ void downloadInputFiles() throws PreComputeException {
 
     /**
      * Added for testing purpose.
-     * @return
+     * @return A {@link PreComputeArgs} instance
      */
     PreComputeArgs getPreComputeArgs() {
         return preComputeArgs;