Fix Javadoc

jmini · jmini · commit 6304f43fa195 · 2025-04-15T06:41:40.000+02:00
diff --git a/gitlab4j-api/src/main/java/org/gitlab4j/api/JobApi.java b/gitlab4j-api/src/main/java/org/gitlab4j/api/JobApi.java
@@ -310,11 +310,11 @@ public Job getJob() throws GitLabApiException {
     }
 
     /**
-     * Retrieve the job corresponding to the <code>$CI_JOB_TOKEN</code> environment variable.
+     * Retrieve the job corresponding to the <code>$CI_JOB_TOKEN</code> environment variable. This works only when used without any authentication.
      *
      * <pre><code>GitLab Endpoint: GET /job?job_token=${ciJobToken}"</code></pre>
      *
-     * @return a single job corresponding to the passed token
+     * @return a single job corresponding to the token passed as query parameter
      * @throws GitLabApiException if any exception occurs during execution
      */
     public Job getJob(final String ciJobToken) throws GitLabApiException {

Original file line number	Diff line number	Diff line change
`@@ -310,11 +310,11 @@ public Job getJob() throws GitLabApiException {`
`310`	`310`	`}`
`311`	`311`
`312`	`312`	`/**`
`313`		`- * Retrieve the job corresponding to the <code>$CI_JOB_TOKEN</code> environment variable.`
	`313`	`+ * Retrieve the job corresponding to the <code>$CI_JOB_TOKEN</code> environment variable. This works only when used without any authentication.`
`314`	`314`	`*`
`315`	`315`	`* <pre><code>GitLab Endpoint: GET /job?job_token=${ciJobToken}"</code></pre>`
`316`	`316`	`*`
`317`		`- * @return a single job corresponding to the passed token`
	`317`	`+ * @return a single job corresponding to the token passed as query parameter`
`318`	`318`	`* @throws GitLabApiException if any exception occurs during execution`
`319`	`319`	`*/`
`320`	`320`	`public Job getJob(final String ciJobToken) throws GitLabApiException {`