Skip to content

Add Kdoc for parseAsXyz(filePath: ...) #6421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martinbonnin merged 1 commit into from
Mar 14, 2025
Merged

Add Kdoc for parseAsXyz(filePath: ...) #6421

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions libraries/apollo-ast/src/commonMain/kotlin/com/apollographql/apollo/ast/api.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,10 @@ fun String.toGQLSelections(options: ParserOptions = ParserOptions.Default): List
* You can then use [validateAsSchema] to validate the contents and get a [Schema].
* Or use [validateAsExecutable] to validate the contents get a list of operations/fragments.
*
* Closes [BufferedSource]
* Closes [BufferedSource].
*
* @param filePath the path of a file on the host filesystem where the source is coming from. If provided, [filePath]
* is used to display context for parsing errors. If the source doesn't come from a file, pass `null`.
* @return a [GQLResult] with either a non-null [GQLDocument] or a list of issues.
*/
@ApolloExperimental
Expand All @@ -152,7 +154,10 @@ fun BufferedSource.parseAsGQLDocument(filePath: String? = null, options: ParserO
/**
* Parses the source to a [GQLValue], validating the syntax but not the contents of the value.
*
* Closes [BufferedSource]
* Closes [BufferedSource].
*
* @param filePath the path of a file on the host filesystem where the source is coming from. If provided, [filePath]
* is used to display context for parsing errors. If the source doesn't come from a file, pass `null`.
*/
@ApolloExperimental
fun BufferedSource.parseAsGQLValue(filePath: String? = null, options: ParserOptions = ParserOptions.Default): GQLResult<GQLValue> {
Expand All @@ -162,7 +167,10 @@ fun BufferedSource.parseAsGQLValue(filePath: String? = null, options: ParserOpti
/**
* Parses the source to a [GQLType], validating the syntax but not the contents of the value.
*
* Closes [BufferedSource]
* Closes [BufferedSource].
*
* @param filePath the path of a file on the host filesystem where the source is coming from. If provided, [filePath]
* is used to display context for parsing errors. If the source doesn't come from a file, pass `null`.
*/
@ApolloExperimental
fun BufferedSource.parseAsGQLType(filePath: String? = null, options: ParserOptions = ParserOptions.Default): GQLResult<GQLType> {
Expand All @@ -173,6 +181,9 @@ fun BufferedSource.parseAsGQLType(filePath: String? = null, options: ParserOptio
* Parses the source to a [List]<[GQLSelection]>, validating the syntax but not the contents of the selections.
*
* Closes [BufferedSource]
*
* @param filePath the path of a file on the host filesystem where the source is coming from. If provided, [filePath]
* is used to display context for parsing errors. If the source doesn't come from a file, pass `null`.
*/
@ApolloExperimental
fun BufferedSource.parseAsGQLSelections(
Expand Down
Loading