Skip to content

Commit

Permalink
docs: Fix warnings in codegen documentation generation (#125)
Browse files Browse the repository at this point in the history
Co-authored-by: Matthew Thompson <thompson.matthew@heb.com>
  • Loading branch information
mt00chikin and thompsonmatthew-heb authored Nov 8, 2023
1 parent 1760ef2 commit 0c0c4f6
Show file tree
Hide file tree
Showing 24 changed files with 243 additions and 59 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -669,7 +669,7 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {
/// schema in generated code.
public struct ConversionStrategies: Codable, Equatable {

/// ``ApolloCodegenConfiguration/ConversionStrategies/EnumCase`` is used to specify the strategy
/// ``ApolloCodegenConfiguration/ConversionStrategies/EnumCases`` is used to specify the strategy
/// used to convert the casing of enum cases in a GraphQL schema into generated Swift code.
public enum EnumCases: String, Codable, Equatable {
/// Generates swift code using the exact name provided in the GraphQL schema
Expand All @@ -695,12 +695,12 @@ public struct ApolloCodegenConfiguration: Codable, Equatable {

/// Determines how the names of enum cases in the GraphQL schema will be converted into
/// cases on the generated Swift enums.
/// Defaultss to ``ApolloCodegenConfiguration/CaseConversionStrategy/camelCase``
/// Defaults to ``ApolloCodegenConfiguration/ConversionStrategies/CaseConversionStrategy/camelCase``
public let enumCases: EnumCases

/// Determines how the names of fields in the GraphQL schema will be converted into
/// properties in the generated Swift code.
/// Defaults to ``ApolloCodegenConfiguration/CaseConversionStrategy/camelCase``
/// Defaults to ``ApolloCodegenConfiguration/ConversionStrategies/FieldAccessors/idiomatic``
public let fieldAccessors: FieldAccessors

/// Default property values
Expand Down Expand Up @@ -1448,7 +1448,7 @@ extension ApolloCodegenConfiguration.ConversionStrategies {

/// ``CaseConversionStrategy`` is used to specify the strategy used to convert the casing of
/// GraphQL schema values into generated Swift code.
@available(*, deprecated, message: "Use EnumCaseConversionStrategy instead.")
@available(*, deprecated, message: "Use EnumCases instead.")
public enum CaseConversionStrategy: String, Codable, Equatable {
/// Generates swift code using the exact name provided in the GraphQL schema
/// performing no conversion.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
"defaultImplementationsSections" : [
{
"identifiers" : [
"doc:\/\/ApolloAPI\/documentation\/ApolloAPI\/GraphQLOperation\/operationType-370r3",
"doc:\/\/ApolloAPI\/documentation\/ApolloAPI\/GraphQLOperation\/operationType-90ybj",
"doc:\/\/ApolloAPI\/documentation\/ApolloAPI\/GraphQLOperation\/operationType-5e63x"
"doc:\/\/ApolloAPI\/documentation\/ApolloAPI\/GraphQLOperation\/operationType-5e63x",
"doc:\/\/ApolloAPI\/documentation\/ApolloAPI\/GraphQLOperation\/operationType-370r3"
],
"title" : "GraphQLOperation Implementations"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -901,7 +901,7 @@
"type" : "text"
},
{
"code" : "AnyScalarType",
"code" : "JSONEncodable",
"type" : "codeVoice"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@
"type" : "text"
},
{
"code" : "AnyScalarType",
"code" : "JSONEncodable",
"type" : "codeVoice"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,59 @@
"type" : "topic",
"url" : "\/documentation\/apollocodegenlib\/apollocodegenconfiguration\/conversionstrategies\/caseconversionstrategy"
},
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/CaseConversionStrategy/camelCase": {
"abstract" : [
{
"text" : "Convert to lower camel case from ",
"type" : "text"
},
{
"code" : "snake_case",
"type" : "codeVoice"
},
{
"text" : ", ",
"type" : "text"
},
{
"code" : "UpperCamelCase",
"type" : "codeVoice"
},
{
"text" : ", or ",
"type" : "text"
},
{
"code" : "UPPERCASE",
"type" : "codeVoice"
},
{
"text" : ".",
"type" : "text"
}
],
"deprecated" : true,
"fragments" : [
{
"kind" : "keyword",
"text" : "case"
},
{
"kind" : "text",
"text" : " "
},
{
"kind" : "identifier",
"text" : "camelCase"
}
],
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/CaseConversionStrategy\/camelCase",
"kind" : "symbol",
"role" : "symbol",
"title" : "ApolloCodegenConfiguration.ConversionStrategies.CaseConversionStrategy.camelCase",
"type" : "topic",
"url" : "\/documentation\/apollocodegenlib\/apollocodegenconfiguration\/conversionstrategies\/caseconversionstrategy\/camelcase"
},
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/CodingKeys": {
"abstract" : [

Expand Down Expand Up @@ -391,8 +444,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down Expand Up @@ -500,6 +554,34 @@
"type" : "topic",
"url" : "\/documentation\/apollocodegenlib\/apollocodegenconfiguration\/conversionstrategies\/fieldaccessors-swift.enum"
},
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/FieldAccessors-swift.enum/idiomatic": {
"abstract" : [
{
"text" : "This conversion strategy will:",
"type" : "text"
}
],
"fragments" : [
{
"kind" : "keyword",
"text" : "case"
},
{
"kind" : "text",
"text" : " "
},
{
"kind" : "identifier",
"text" : "idiomatic"
}
],
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/FieldAccessors-swift.enum\/idiomatic",
"kind" : "symbol",
"role" : "symbol",
"title" : "ApolloCodegenConfiguration.ConversionStrategies.FieldAccessors.idiomatic",
"type" : "topic",
"url" : "\/documentation\/apollocodegenlib\/apollocodegenconfiguration\/conversionstrategies\/fieldaccessors-swift.enum\/idiomatic"
},
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/enumCases-swift.property": {
"abstract" : [
{
Expand All @@ -519,12 +601,13 @@
"type" : "text"
},
{
"text" : "Defaultss to ",
"text" : "Defaults to ",
"type" : "text"
},
{
"code" : "ApolloCodegenConfiguration\/CaseConversionStrategy\/camelCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/CaseConversionStrategy\/camelCase",
"isActive" : true,
"type" : "reference"
}
],
"fragments" : [
Expand Down Expand Up @@ -598,8 +681,9 @@
"type" : "text"
},
{
"code" : "ApolloCodegenConfiguration\/CaseConversionStrategy\/camelCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/FieldAccessors-swift.enum\/idiomatic",
"isActive" : true,
"type" : "reference"
}
],
"fragments" : [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
{
"inlineContent" : [
{
"text" : "Use EnumCaseConversionStrategy instead.",
"text" : "Use EnumCases instead.",
"type" : "text"
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
{
"inlineContent" : [
{
"text" : "Use EnumCaseConversionStrategy instead.",
"text" : "Use EnumCases instead.",
"type" : "text"
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{
"inlineContent" : [
{
"text" : "Use EnumCaseConversionStrategy instead.",
"text" : "Use EnumCases instead.",
"type" : "text"
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{
"inlineContent" : [
{
"text" : "Use EnumCaseConversionStrategy instead.",
"text" : "Use EnumCases instead.",
"type" : "text"
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -356,8 +356,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down Expand Up @@ -274,8 +275,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -298,8 +298,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -219,8 +219,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -314,8 +314,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -322,8 +322,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -286,8 +286,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -298,8 +298,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -229,8 +229,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,9 @@
"doc://ApolloCodegenLib/documentation/ApolloCodegenLib/ApolloCodegenConfiguration/ConversionStrategies/EnumCases-swift.enum": {
"abstract" : [
{
"code" : "ApolloCodegenConfiguration\/ConversionStrategies\/EnumCase",
"type" : "codeVoice"
"identifier" : "doc:\/\/ApolloCodegenLib\/documentation\/ApolloCodegenLib\/ApolloCodegenConfiguration\/ConversionStrategies\/EnumCases-swift.enum",
"isActive" : true,
"type" : "reference"
},
{
"text" : " is used to specify the strategy",
Expand Down
Loading

0 comments on commit 0c0c4f6

Please sign in to comment.