Skip to content

Commit 5e819d8

Browse files
committed
Revert "Fix: Javadoc issues in io.a2a.spec package"
This reverts commit 71ff747.
1 parent 71ff747 commit 5e819d8

File tree

74 files changed

+1386
-478
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

+1386
-478
lines changed

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

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

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

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

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

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

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

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

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-
* Creates a new builder for {@link APIKeySecurityScheme}.
152+
* Create a new Builder
153153
*
154-
* @return a new builder instance
154+
* @return the builder
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-
* Creates a new builder for {@link AgentCapabilities}.
38+
* Create a new Builder
3939
*
40-
* @return a new builder instance
40+
* @return the builder
4141
*/
4242
public static Builder builder() {
4343
return new Builder();
4444
}
4545
/**
46-
* Builder for constructing immutable {@code AgentCapabilities} instances.
46+
* Builder for constructing immutable {@link 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: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,24 @@ 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
6886
*/
6987
public AgentCard {
7088
Assert.checkNotNullParam("capabilities", capabilities);
@@ -105,7 +123,7 @@ public static Builder builder(AgentCard card) {
105123

106124

107125
/**
108-
* Builder for constructing immutable {@code AgentCard} instances.
126+
* Builder for constructing immutable {@link AgentCard} instances.
109127
* <p>
110128
* The Builder pattern is used to enforce immutability of AgentCard objects while providing
111129
* 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: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ 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)
4043
* @throws IllegalArgumentException if protectedHeader or signature is null
4144
*/
4245
public AgentCardSignature {
@@ -45,9 +48,9 @@ public record AgentCardSignature(Map<String, Object> header, @SerializedName("pr
4548
}
4649

4750
/**
48-
* Creates a new builder for {@link AgentCardSignature}.
51+
* Create a new Builder
4952
*
50-
* @return a new builder instance
53+
* @return the builder
5154
*/
5255
public static Builder builder() {
5356
return new Builder();

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,20 @@ 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)
3135
* @throws IllegalArgumentException if uri is null
3236
*/
3337
public AgentExtension {
3438
Assert.checkNotNullParam("uri", uri);
3539
}
3640

3741
/**
38-
* Creates a new builder for {@link AgentExtension}.
42+
* Create a new Builder
3943
*
40-
* @return a new builder instance
44+
* @return the builder
4145
*/
4246
public static Builder builder() {
4347
return new Builder();

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ 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)
3235
* @throws IllegalArgumentException if protocolBinding or url is null
3336
*/
3437
public AgentInterface {

0 commit comments

Comments
 (0)