Skip to content

Commit fb95af2

Browse files
authored
fix(docs): Update KDocs, fix links and cross-references (#476)
- Fix broken links in KDocs and introducing valid references to related API components. - Enhanced descriptions - Also added clarity by linking to specification classes directly for better usability.
1 parent 9b0e18b commit fb95af2

File tree

48 files changed

+233
-179
lines changed

Some content is hidden

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

48 files changed

+233
-179
lines changed

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/AgentSkill.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public data class AgentSkill(
3030
/**
3131
* A set of keywords describing the skill's capabilities.
3232
*
33-
* @sample ["cooking", "customer support", "billing"]
33+
* Example: `["cooking", "customer support", "billing"]`
3434
*/
3535
@SerialName("tags")
3636
val tags: List<String>,
@@ -39,7 +39,7 @@ public data class AgentSkill(
3939
* Example prompts or scenarios that this skill can handle. Provides a hint to
4040
* the client on how to use the skill.
4141
*
42-
* @sample ["I need a recipe for bread"]
42+
* Example: `["I need a recipe for bread"]`
4343
*/
4444
@SerialName("examples")
4545
val examples: List<String>? = null,
@@ -58,12 +58,12 @@ public data class AgentSkill(
5858

5959
/**
6060
* Security schemes necessary for the agent to leverage this skill.
61-
* As in the overall AgentCard.security, this list represents a logical OR of security
61+
* As in the overall [AgentCard.security], this list represents a logical OR of security
6262
* requirement objects. Each object is a set of security schemes that must be used together
6363
* (a logical AND).
6464
*
65-
* @sample
66-
* ```
65+
* Example:
66+
* ```kotlin
6767
* [
6868
* {
6969
* "google": [ "oidc" ]
@@ -76,7 +76,7 @@ public data class AgentSkill(
7676
) {
7777
public companion object {
7878
/**
79-
* Creates a new AgentSkill using the DSL builder.
79+
* Creates a new [AgentSkill] using the DSL builder.
8080
*
8181
* @param init The lambda to configure the agent skill.
8282
* @return A new AgentSkill instance.

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/CancelTaskRequestBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public fun cancelTaskRequest(init: Consumer<CancelTaskRequestBuilder>): CancelTa
8383
}
8484

8585
/**
86-
* DSL extension for [CancelTaskRequest.Companion].
86+
* DSL extension for [CancelTaskRequest].
8787
*
8888
* @param init The lambda to configure the cancel task request.
8989
* @return A new [CancelTaskRequest] instance.
@@ -93,7 +93,7 @@ public fun CancelTaskRequest.Companion.create(
9393
): CancelTaskRequest = CancelTaskRequestBuilder().apply(init).build()
9494

9595
/**
96-
* Java-friendly DSL extension for [CancelTaskRequest.Companion].
96+
* Java-friendly DSL extension for [CancelTaskRequest].
9797
*
9898
* @param init The consumer to configure the cancel task request.
9999
* @return A new [CancelTaskRequest] instance.

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/CancelTaskResponseBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ public fun cancelTaskResponse(init: Consumer<CancelTaskResponseBuilder>): Cancel
111111
}
112112

113113
/**
114-
* DSL extension for [CancelTaskResponse.Companion].
114+
* DSL extension for [CancelTaskResponse].
115115
*
116116
* @param init The lambda to configure the cancel task response.
117117
* @return A new [CancelTaskResponse] instance.
@@ -121,7 +121,7 @@ public fun CancelTaskResponse.Companion.create(
121121
): CancelTaskResponse = CancelTaskResponseBuilder().apply(init).build()
122122

123123
/**
124-
* Java-friendly DSL extension for [CancelTaskResponse.Companion].
124+
* Java-friendly DSL extension for [CancelTaskResponse].
125125
*
126126
* @param init The consumer to configure the cancel task response.
127127
* @return A new [CancelTaskResponse] instance.

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/DeleteTaskPushNotificationConfigRequestBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public fun deleteTaskPushNotificationConfigRequest(
9696
}
9797

9898
/**
99-
* DSL extension for [DeleteTaskPushNotificationConfigRequest.Companion].
99+
* DSL extension for [DeleteTaskPushNotificationConfigRequest].
100100
*
101101
* @param init The lambda to configure the delete task push notification config request.
102102
* @return A new [DeleteTaskPushNotificationConfigRequest] instance.
@@ -107,7 +107,7 @@ public fun DeleteTaskPushNotificationConfigRequest.Companion.create(
107107
DeleteTaskPushNotificationConfigRequestBuilder().apply(init).build()
108108

109109
/**
110-
* Java-friendly DSL extension for [DeleteTaskPushNotificationConfigRequest.Companion].
110+
* Java-friendly DSL extension for [DeleteTaskPushNotificationConfigRequest].
111111
*
112112
* @param init The consumer to configure the delete task push notification config request.
113113
* @return A new [DeleteTaskPushNotificationConfigRequest] instance.

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/FileContent.kt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ import kotlinx.serialization.Serializable
88
* Represents the content of a file, either as base64 encoded bytes or a URI.
99
*
1010
* This is a union type that can represent either:
11-
* - [FileWithBytes]: File content provided directly as base64-encoded bytes
12-
* - [FileWithUri]: File content located at a specific URI
11+
* - File content provided directly as base64-encoded bytes (via [bytes] property)
12+
* - File content located at a specific URI (via [uri] property)
1313
*
14-
* Either 'bytes' or 'uri' should be provided, but not both.
14+
* Either [bytes] or [uri] should be provided, but not both.
1515
*/
1616
@Serializable
1717
public data class FileContent(
@@ -29,15 +29,15 @@ public data class FileContent(
2929

3030
/**
3131
* The base64-encoded content of the file.
32-
* Present when representing a [FileWithBytes].
32+
* Present when representing file content directly.
3333
*/
3434
@Serializable(with = ByteArrayAsBase64Serializer::class)
3535
@SerialName("bytes")
3636
val bytes: ByteArray? = null,
3737

3838
/**
3939
* A URL pointing to the file's content.
40-
* Present when representing a [FileWithUri].
40+
* Present when representing file content via URI.
4141
*/
4242
@SerialName("uri")
4343
val uri: String? = null,

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/GetAuthenticatedExtendedCardRequestBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public fun getAuthenticatedExtendedCardRequest(
6363
}
6464

6565
/**
66-
* DSL extension for [GetAuthenticatedExtendedCardRequest.Companion].
66+
* DSL extension for [GetAuthenticatedExtendedCardRequest].
6767
*
6868
* @param init The lambda to configure the get authenticated extended card request.
6969
* @return A new [GetAuthenticatedExtendedCardRequest] instance.
@@ -74,7 +74,7 @@ public fun GetAuthenticatedExtendedCardRequest.Companion.create(
7474
GetAuthenticatedExtendedCardRequestBuilder().apply(init).build()
7575

7676
/**
77-
* Java-friendly DSL extension for [GetAuthenticatedExtendedCardRequest.Companion].
77+
* Java-friendly DSL extension for [GetAuthenticatedExtendedCardRequest].
7878
*
7979
* @param init The consumer to configure the get authenticated extended card request.
8080
* @return A new [GetAuthenticatedExtendedCardRequest] instance.

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/GetTaskPushNotificationRequestBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ public fun getTaskPushNotificationRequest(
9595
}
9696

9797
/**
98-
* DSL extension for [GetTaskPushNotificationRequest.Companion].
98+
* DSL extension for [GetTaskPushNotificationRequest].
9999
*
100100
* @param init The lambda to configure the get task push notification request.
101101
* @return A new [GetTaskPushNotificationRequest] instance.
@@ -105,7 +105,7 @@ public fun GetTaskPushNotificationRequest.Companion.create(
105105
): GetTaskPushNotificationRequest = GetTaskPushNotificationRequestBuilder().apply(init).build()
106106

107107
/**
108-
* Java-friendly DSL extension for [GetTaskPushNotificationRequest.Companion].
108+
* Java-friendly DSL extension for [GetTaskPushNotificationRequest].
109109
*
110110
* @param init The consumer to configure the get task push notification request.
111111
* @return A new [GetTaskPushNotificationRequest] instance.

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/GetTaskPushNotificationResponseBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ public fun getTaskPushNotificationResponse(
117117
}
118118

119119
/**
120-
* DSL extension for [GetTaskPushNotificationResponse.Companion].
120+
* DSL extension for [GetTaskPushNotificationResponse].
121121
*
122122
* @param init The lambda to configure the get task push notification response.
123123
* @return A new [GetTaskPushNotificationResponse] instance.
@@ -127,7 +127,7 @@ public fun GetTaskPushNotificationResponse.Companion.create(
127127
): GetTaskPushNotificationResponse = GetTaskPushNotificationResponseBuilder().apply(init).build()
128128

129129
/**
130-
* Java-friendly DSL extension for [GetTaskPushNotificationResponse.Companion].
130+
* Java-friendly DSL extension for [GetTaskPushNotificationResponse].
131131
*
132132
* @param init The consumer to configure the get task push notification response.
133133
* @return A new [GetTaskPushNotificationResponse] instance.

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/GetTaskRequestBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public fun getTaskRequest(init: Consumer<GetTaskRequestBuilder>): GetTaskRequest
9090
}
9191

9292
/**
93-
* DSL extension for [GetTaskRequest.Companion].
93+
* DSL extension for [GetTaskRequest].
9494
*
9595
* @param init The lambda to configure the get task request.
9696
* @return A new [GetTaskRequest] instance.
@@ -99,7 +99,7 @@ public fun GetTaskRequest.Companion.create(init: GetTaskRequestBuilder.() -> Uni
9999
GetTaskRequestBuilder().apply(init).build()
100100

101101
/**
102-
* Java-friendly DSL extension for [GetTaskRequest.Companion].
102+
* Java-friendly DSL extension for [GetTaskRequest].
103103
*
104104
* @param init The consumer to configure the get task request.
105105
* @return A new [GetTaskRequest] instance.

ai-mocks-a2a-models/src/commonMain/kotlin/dev/mokksy/aimocks/a2a/model/GetTaskResponseBuilder.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ public fun getTaskResponse(init: Consumer<GetTaskResponseBuilder>): GetTaskRespo
110110
}
111111

112112
/**
113-
* DSL extension for [GetTaskResponse.Companion].
113+
* DSL extension for [GetTaskResponse].
114114
*
115115
* @param init The lambda to configure the get task response.
116116
* @return A new [GetTaskResponse] instance.
@@ -120,7 +120,7 @@ public fun GetTaskResponse.Companion.create(
120120
): GetTaskResponse = GetTaskResponseBuilder().apply(init).build()
121121

122122
/**
123-
* Java-friendly DSL extension for [GetTaskResponse.Companion].
123+
* Java-friendly DSL extension for [GetTaskResponse].
124124
*
125125
* @param init The consumer to configure the get task response.
126126
* @return A new [GetTaskResponse] instance.

0 commit comments

Comments
 (0)