Skip to content

Commit cdc07d2

Browse files
committed
Fix javadoc errors
1 parent 726e4f2 commit cdc07d2

File tree

5 files changed

+11
-13
lines changed

5 files changed

+11
-13
lines changed

src/main/java/io/github/lambdatest/gradle/AppUploader.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ public AppUploader(String username, String accessKey, String appFilePath) {
4040
/**
4141
* Uploads the application file asynchronously to LambdaTest.
4242
*
43+
* <p>Implementation Note: Uses CompletableFuture to perform the upload asynchronously, allowing parallel processing of other tasks.</p>
44+
*
4345
* @return A CompletableFuture that resolves to the uploaded application's ID
44-
* @implNote Uses CompletableFuture to perform the upload asynchronously, allowing parallel
45-
* processing of other tasks
4646
*/
4747
public CompletableFuture<String> uploadAppAsync() {
4848
return CompletableFuture.supplyAsync(

src/main/java/io/github/lambdatest/gradle/LambdaTestTask.java

+2-4
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,8 @@ public class LambdaTestTask extends DefaultTask {
5050
* Executes the LambdaTest task, which includes uploading the application and test suite,
5151
* followed by test execution on the LambdaTest platform.
5252
*
53-
* @implNote This method handles the task execution in three main phases: 1. Asynchronous upload
54-
* of the application using {@link AppUploader#uploadAppAsync()} 2. Asynchronous upload of
55-
* the test suite using {@link TestSuiteUploader#uploadTestSuiteAsync()} 3. Test execution
56-
* with {@link TestExecutor#executeTests(Map)}
53+
* <p>Implementation Note:This method handles the task execution in three main phases: 1. Asynchronous upload of the application using {@link AppUploader#uploadAppAsync()} 2. Asynchronous upload of the test suite using {@link TestSuiteUploader#uploadTestSuiteAsync()} 3. Test execution with {@link TestExecutor#executeTests(Map)}</p>
54+
*
5755
* @throws RuntimeException if any upload or test execution fails
5856
*/
5957
@TaskAction

src/main/java/io/github/lambdatest/gradle/TestExecutor.java

+2-3
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,10 @@ public TestExecutor(
5353
/**
5454
* Executes the tests on LambdaTest with the specified parameters.
5555
*
56+
* <p>Implementation Note: This method constructs the test capabilities and sends them to either {@link Constants#BUILD_URL} or {@link Constants#FLUTTER_BUILD_URL} based on whether it's a Flutter or standard application.</p>
57+
*
5658
* @param params Map of additional test execution parameters
5759
* @throws IOException if there's an error in communication with the LambdaTest API
58-
* @implNote This method constructs the test capabilities and sends them to either {@link
59-
* Constants#BUILD_URL} or {@link Constants#FLUTTER_BUILD_URL} based on whether it's a
60-
* Flutter or standard application
6160
*/
6261
public void executeTests(Map<String, String> params) throws IOException {
6362
try {

src/main/java/io/github/lambdatest/gradle/TestSuiteUploader.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ public TestSuiteUploader(String username, String accessKey, String testSuiteFile
3333
/**
3434
* Uploads the test suite file asynchronously to LambdaTest.
3535
*
36+
* <p>Implementation Note: Uses CompletableFuture to perform the upload asynchronously, allowing parallel processing of other tasks.</p>
37+
*
3638
* @return A CompletableFuture that resolves to the uploaded test suite's ID
37-
* @implNote Uses CompletableFuture to perform the upload asynchronously, allowing parallel
38-
* processing of other tasks
3939
*/
4040
public CompletableFuture<String> uploadTestSuiteAsync() {
4141
return CompletableFuture.supplyAsync(

src/main/java/io/github/lambdatest/gradle/UploaderUtil.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,14 @@ private UploaderUtil() {
2929
/**
3030
* Uploads a file to LambdaTest and returns its ID.
3131
*
32+
* <p>Implementation Note: This method sends the file to {@link Constants#API_URL} and handles the multipart form data construction and response parsing.</p>
33+
*
3234
* @param username The LambdaTest account username
3335
* @param accessKey The LambdaTest account access key
3436
* @param filePath The path to the file to be uploaded
3537
* @return The ID of the uploaded file
3638
* @throws IOException if there's an error during file upload or response parsing
37-
* @implNote This method sends the file to {@link Constants#API_URL} and handles the multipart
38-
* form data construction and response parsing
39+
*
3940
*/
4041
public static String uploadAndGetId(String username, String accessKey, String filePath)
4142
throws IOException {

0 commit comments

Comments
 (0)