Use doc comment syntax for request comment blocks

Author: wravery

include/ClientGenerator.h

@@ -41,6 +41,7 @@ class Generator
 	const std::string& getClientNamespace() const noexcept;
 
 	bool outputHeader() const noexcept;
+	void outputRequestComment(std::ostream& headerFile) const noexcept;
 	void outputGetRequestDeclaration(std::ostream& headerFile) const noexcept;
 	bool outputResponseFieldType(std::ostream& headerFile, const ResponseField& responseField,
 		size_t indent = 0) const noexcept;

samples/client/MutateClient.h

@@ -26,25 +26,26 @@ static_assert(graphql::internal::MinorVersion == 6, "regenerate with clientgen:
 #include <string>
 #include <vector>
 
-namespace graphql::mutation::CompleteTaskMutation {
 
-/** Operation: mutation CompleteTaskMutation
- **
- ** # Copyright (c) Microsoft Corporation. All rights reserved.
- ** # Licensed under the MIT License.
- ** 
- ** mutation CompleteTaskMutation($input: CompleteTaskInput! = {id: "ZmFrZVRhc2tJZA==", isComplete: true, clientMutationId: "Hi There!"}) {
- **   completedTask: completeTask(input: $input) {
- **     completedTask: task {
- **       completedTaskId: id
- **       title
- **       isComplete
- **     }
- **     clientMutationId
- **   }
- ** }
- **
- **/
+/// <summary>
+/// Operation: mutation CompleteTaskMutation
+/// </summary>
+/// <code class="language-graphql">
+/// # Copyright (c) Microsoft Corporation. All rights reserved.
+/// # Licensed under the MIT License.
+/// 
+/// mutation CompleteTaskMutation($input: CompleteTaskInput! = {id: "ZmFrZVRhc2tJZA==", isComplete: true, clientMutationId: "Hi There!"}) {
+///   completedTask: completeTask(input: $input) {
+///     completedTask: task {
+///       completedTaskId: id
+///       title
+///       isComplete
+///     }
+///     clientMutationId
+///   }
+/// }
+/// </code>
+namespace graphql::mutation::CompleteTaskMutation {
 
 // Return the original text of the request document.
 const std::string& GetRequestText() noexcept;

samples/client/QueryClient.h

@@ -26,51 +26,52 @@ static_assert(graphql::internal::MinorVersion == 6, "regenerate with clientgen:
 #include <string>
 #include <vector>
 
-namespace graphql::query::Query {
 
-/** Operation: query (default)
- **
- ** # Copyright (c) Microsoft Corporation. All rights reserved.
- ** # Licensed under the MIT License.
- ** 
- ** query {
- **   appointments {
- **     edges {
- **       node {
- **         id
- **         subject
- **         when
- **         isNow
- **         __typename
- **       }
- **     }
- **   }
- **   tasks {
- **     edges {
- **       node {
- **         id
- **         title
- **         isComplete
- **         __typename
- **       }
- **     }
- **   }
- **   unreadCounts {
- **     edges {
- **       node {
- **         id
- **         name
- **         unreadCount
- **         __typename
- **       }
- **     }
- **   }
- ** 
- **   # Read a field with an enum type
- **   testTaskState
- ** }
- **
- **/
+/// <summary>
+/// Operation: query (default)
+/// </summary>
+/// <code class="language-graphql">
+/// # Copyright (c) Microsoft Corporation. All rights reserved.
+/// # Licensed under the MIT License.
+/// 
+/// query {
+///   appointments {
+///     edges {
+///       node {
+///         id
+///         subject
+///         when
+///         isNow
+///         __typename
+///       }
+///     }
+///   }
+///   tasks {
+///     edges {
+///       node {
+///         id
+///         title
+///         isComplete
+///         __typename
+///       }
+///     }
+///   }
+///   unreadCounts {
+///     edges {
+///       node {
+///         id
+///         name
+///         unreadCount
+///         __typename
+///       }
+///     }
+///   }
+/// 
+///   # Read a field with an enum type
+///   testTaskState
+/// }
+/// </code>
+namespace graphql::query::Query {
 
 // Return the original text of the request document.
 const std::string& GetRequestText() noexcept;

samples/client/SubscribeClient.h

@@ -26,23 +26,24 @@ static_assert(graphql::internal::MinorVersion == 6, "regenerate with clientgen:
 #include <string>
 #include <vector>
 
-namespace graphql::subscription::TestSubscription {
 
-/** Operation: subscription TestSubscription
- **
- ** # Copyright (c) Microsoft Corporation. All rights reserved.
- ** # Licensed under the MIT License.
- ** 
- ** subscription TestSubscription {
- **   nextAppointment: nextAppointmentChange {
- **     nextAppointmentId: id
- **     when
- **     subject
- **     isNow
- **   }
- ** }
- **
- **/
+/// <summary>
+/// Operation: subscription TestSubscription
+/// </summary>
+/// <code class="language-graphql">
+/// # Copyright (c) Microsoft Corporation. All rights reserved.
+/// # Licensed under the MIT License.
+/// 
+/// subscription TestSubscription {
+///   nextAppointment: nextAppointmentChange {
+///     nextAppointmentId: id
+///     when
+///     subject
+///     isNow
+///   }
+/// }
+/// </code>
+namespace graphql::subscription::TestSubscription {
 
 // Return the original text of the request document.
 const std::string& GetRequestText() noexcept;

src/ClientGenerator.cpp

@@ -165,6 +165,8 @@ static_assert(graphql::internal::MinorVersion == )cpp"
 
 )cpp";
 
+	outputRequestComment(headerFile);
+
 	NamespaceScope clientNamespaceScope { headerFile, getClientNamespace() };
 	PendingBlankLine pendingSeparator { headerFile };
 
@@ -281,25 +283,31 @@ Response parseResponse(response::Value&& response);
 	return true;
 }
 
-void Generator::outputGetRequestDeclaration(std::ostream& headerFile) const noexcept
+void Generator::outputRequestComment(std::ostream& headerFile) const noexcept
 {
 	headerFile << R"cpp(
-/** Operation: )cpp"
+/// <summary>
+/// Operation: )cpp"
 			   << _requestLoader.getOperationType() << ' '
 			   << _requestLoader.getOperationDisplayName() << R"cpp(
- **
+/// </summary>
+/// <code class="language-graphql">
 )cpp";
 
 	std::istringstream request { std::string { _requestLoader.getRequestText() } };
 
 	for (std::string line; std::getline(request, line);)
 	{
-		headerFile << R"cpp( ** )cpp" << line << std::endl;
+		headerFile << R"cpp(/// )cpp" << line << std::endl;
 	}
 
-	headerFile << R"cpp( **
- **/
+	headerFile << R"cpp(/// </code>
+)cpp";
+}
 
+void Generator::outputGetRequestDeclaration(std::ostream& headerFile) const noexcept
+{
+	headerFile << R"cpp(
 // Return the original text of the request document.
 const std::string& GetRequestText() noexcept;