Skip to content

Commit 71ff747

Browse files
committed
Fix: Javadoc issues in io.a2a.spec package
Addressed the following Javadoc issues: - Removed excessive blank lines within Javadoc comments. - Corrected misplaced file paths in @param tags. - Added missing Javadoc for builder() methods. - Simplified verbose @param tags in compact constructors.
1 parent ebe1b9c commit 71ff747

File tree

74 files changed

+478
-1386
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+478
-1386
lines changed

spec/src/main/java/io/a2a/spec/A2AClientError.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
* <li>{@link A2AClientInvalidStateError} - Invalid client state errors</li>
1515
* <li>{@link A2AClientInvalidArgsError} - Invalid argument errors</li>
1616
* </ul>
17-
*
1817
* @see A2AClientException for general client exceptions
1918
* @see A2AClientHTTPError for HTTP-specific errors
2019
* @see A2AClientJSONError for JSON-specific errors

spec/src/main/java/io/a2a/spec/A2AClientException.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
* <li>HTTP errors ({@link A2AClientHTTPError})</li>
1414
* <li>JSON parsing errors ({@link A2AClientJSONError})</li>
1515
* </ul>
16-
*
1716
* @see A2AException for the base exception class
1817
* @see A2AServerException for server-side errors
1918
* @see A2AClientError for more specific client errors

spec/src/main/java/io/a2a/spec/A2AException.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
* <li>{@link A2AServerException} - Server-side failures</li>
1313
* <li>{@link A2AClientException} - Client-side failures</li>
1414
* </ul>
15-
*
1615
* @see A2AServerException for server-side errors
1716
* @see A2AClientException for client-side errors
1817
* @see <a href="https://a2a-protocol.org/latest/">A2A Protocol Specification</a>

spec/src/main/java/io/a2a/spec/A2AServerException.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
* <li>Resource exhaustion or limits exceeded</li>
1414
* <li>Configuration errors</li>
1515
* </ul>
16-
*
1716
* @see A2AException for the base exception class
1817
* @see A2AClientException for client-side errors
1918
*/

spec/src/main/java/io/a2a/spec/APIKeySecurityScheme.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ public String getType() {
149149
}
150150

151151
/**
152-
* Create a new Builder
152+
* Creates a new builder for {@link APIKeySecurityScheme}.
153153
*
154-
* @return the builder
154+
* @return a new builder instance
155155
*/
156156
public static Builder builder() {
157157
return new Builder();

spec/src/main/java/io/a2a/spec/AgentCapabilities.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ public record AgentCapabilities(boolean streaming, boolean pushNotifications, bo
3535
List<AgentExtension> extensions) {
3636

3737
/**
38-
* Create a new Builder
38+
* Creates a new builder for {@link AgentCapabilities}.
3939
*
40-
* @return the builder
40+
* @return a new builder instance
4141
*/
4242
public static Builder builder() {
4343
return new Builder();
4444
}
4545
/**
46-
* Builder for constructing immutable {@link AgentCapabilities} instances.
46+
* Builder for constructing immutable {@code AgentCapabilities} instances.
4747
* <p>
4848
* The Builder pattern provides a fluent API for setting capability flags.
4949
* All capabilities default to false if not explicitly set.

spec/src/main/java/io/a2a/spec/AgentCard.java

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -65,24 +65,6 @@ public record AgentCard(
6565

6666
/**
6767
* Compact constructor that validates required fields and sets defaults.
68-
*
69-
* @param name the name parameter (see class-level JavaDoc)
70-
* @param description the description parameter (see class-level JavaDoc)
71-
* @param provider the provider parameter (see class-level JavaDoc)
72-
* @param version the version parameter (see class-level JavaDoc)
73-
* @param documentationUrl the documentationUrl parameter (see class-level JavaDoc)
74-
* @param capabilities the capabilities parameter (see class-level JavaDoc)
75-
* @param defaultInputModes the defaultInputModes parameter (see class-level JavaDoc)
76-
* @param defaultOutputModes the defaultOutputModes parameter (see class-level JavaDoc)
77-
* @param skills the skills parameter (see class-level JavaDoc)
78-
* @param supportsExtendedAgentCard the supportsExtendedAgentCard parameter (see class-level JavaDoc)
79-
* @param securitySchemes the securitySchemes parameter (see class-level JavaDoc)
80-
* @param security the security parameter (see class-level JavaDoc)
81-
* @param iconUrl the iconUrl parameter (see class-level JavaDoc)
82-
* @param supportedInterfaces the supportedInterfaces parameter (see class-level JavaDoc)
83-
* @param protocolVersion the protocolVersion parameter (see class-level JavaDoc)
84-
* @param signatures the signatures parameter (see class-level JavaDoc)
85-
* @throws IllegalArgumentException if any required field is null
8668
*/
8769
public AgentCard {
8870
Assert.checkNotNullParam("capabilities", capabilities);
@@ -123,7 +105,7 @@ public static Builder builder(AgentCard card) {
123105

124106

125107
/**
126-
* Builder for constructing immutable {@link AgentCard} instances.
108+
* Builder for constructing immutable {@code AgentCard} instances.
127109
* <p>
128110
* The Builder pattern is used to enforce immutability of AgentCard objects while providing
129111
* a fluent API for setting required and optional fields. This approach ensures that once

spec/src/main/java/io/a2a/spec/AgentCardSignature.java

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,6 @@ public record AgentCardSignature(Map<String, Object> header, @SerializedName("pr
3737
/**
3838
* Compact constructor that validates required fields.
3939
*
40-
* @param header the header parameter (see class-level JavaDoc)
41-
* @param protectedHeader the protectedHeader parameter (see class-level JavaDoc)
42-
* @param signature the signature parameter (see class-level JavaDoc)
4340
* @throws IllegalArgumentException if protectedHeader or signature is null
4441
*/
4542
public AgentCardSignature {
@@ -48,9 +45,9 @@ public record AgentCardSignature(Map<String, Object> header, @SerializedName("pr
4845
}
4946

5047
/**
51-
* Create a new Builder
48+
* Creates a new builder for {@link AgentCardSignature}.
5249
*
53-
* @return the builder
50+
* @return a new builder instance
5451
*/
5552
public static Builder builder() {
5653
return new Builder();

spec/src/main/java/io/a2a/spec/AgentExtension.java

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,16 @@ public record AgentExtension (String description, Map<String, Object> params, bo
2828
/**
2929
* Compact constructor that validates required fields.
3030
*
31-
* @param description the description parameter (see class-level JavaDoc)
32-
* @param params the params parameter (see class-level JavaDoc)
33-
* @param required the required parameter (see class-level JavaDoc)
34-
* @param uri the uri parameter (see class-level JavaDoc)
3531
* @throws IllegalArgumentException if uri is null
3632
*/
3733
public AgentExtension {
3834
Assert.checkNotNullParam("uri", uri);
3935
}
4036

4137
/**
42-
* Create a new Builder
38+
* Creates a new builder for {@link AgentExtension}.
4339
*
44-
* @return the builder
40+
* @return a new builder instance
4541
*/
4642
public static Builder builder() {
4743
return new Builder();

spec/src/main/java/io/a2a/spec/AgentInterface.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,6 @@ public record AgentInterface(String protocolBinding, String url, String tenant)
2929
/**
3030
* Compact constructor that validates required fields.
3131
*
32-
* @param protocolBinding the protocolBinding parameter (see class-level JavaDoc)
33-
* @param url the url parameter (see class-level JavaDoc)
34-
* @param tenant the tenant parameter (see class-level JavaDoc)
3532
* @throws IllegalArgumentException if protocolBinding or url is null
3633
*/
3734
public AgentInterface {

0 commit comments

Comments
 (0)