Skip to content

Commit 5d4ab75

Browse files
committed
Minor doc cleanup
1 parent 9cdc100 commit 5d4ab75

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

backend/kobweb-api/src/main/kotlin/com/varabyte/kobweb/api/http/Content.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ interface ContentSource {
4141
}
4242

4343
/**
44-
* Extra information about content should be treated / displayed.
44+
* Extra information about how content should be treated / displayed.
4545
*
4646
* @see <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Disposition">Content-Disposition</a>
4747
*/
@@ -81,7 +81,7 @@ suspend fun ContentSource.stream(): InputStream {
8181
}
8282

8383
/**
84-
* Convenience method to convert a body's content into a raw byte array
84+
* Convenience method to convert a body's content into a raw byte array.
8585
*
8686
* @param limit If set and the size of the body is larger than it, throw an exception.
8787
*/

backend/kobweb-api/src/main/kotlin/com/varabyte/kobweb/api/http/Multipart.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ import java.io.Closeable
1313
* val mp = ctx.req.body?.multipart() ?: return
1414
*
1515
* mp.forEachPart { part ->
16-
* // Here, part.openContent() gives you a ByteSource you can use to stream the content information.
16+
* // Here, part.consumeContent() gives you a ByteSource you can use to stream the content information.
1717
* // If you are sure that the content is fairly limited in size, you can use `part.bytes()` or `part.text()`
1818
* // instead to read everything directly.
1919
*
2020
* // Also, if you sent file data, you can use
21-
* // (part.extras as? Multipart.Part.Extras.File)?.originalFileName
21+
* // (part.extras as? Multipart.Extras.File)?.originalFileName
2222
* // to get the original file name uploaded by the user.
23-
* })
23+
* }
2424
* }
2525
* ```
2626
*/

backend/kobweb-api/src/main/kotlin/com/varabyte/kobweb/api/http/Request.kt

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ import com.varabyte.kobweb.api.ApiContext
44
import com.varabyte.kobweb.api.data.Data
55
import com.varabyte.kobweb.api.data.MutableData
66
import com.varabyte.kobweb.api.intercept.ApiInterceptor
7-
import com.varabyte.kobweb.framework.annotations.DelicateApi
8-
import com.varabyte.kobweb.io.ByteSource
97

108
/**
119
* Information passed into an API endpoint from the client.
@@ -58,7 +56,7 @@ interface Request {
5856
* A holder of user data that can be added to this request.
5957
*
6058
* This will only be relevant for a project that uses an [ApiInterceptor]; in other words, this allows optional
61-
* communication from an API interceptor to an API interceptor (such as storing some calculated auth value).
59+
* communication from an API interceptor to an API handler (such as storing some calculated auth value).
6260
*/
6361
val data: Data
6462
/**

0 commit comments

Comments
 (0)