diff --git a/examples/site/bearer_token/bearer_token.cc b/examples/site/bearer_token/bearer_token.cc index 803b56c5..fad8408b 100644 --- a/examples/site/bearer_token/bearer_token.cc +++ b/examples/site/bearer_token/bearer_token.cc @@ -26,7 +26,7 @@ namespace gcf = ::google::cloud::functions; namespace { -/// A helper function to perform a HTTP GET request. +/// A helper function to perform an HTTP GET request. gcf::HttpResponse HttpGet(std::string const& url, std::string const& authorization_header); } // namespace diff --git a/google/cloud/functions/framework.h b/google/cloud/functions/framework.h index bc795191..5caa46c8 100644 --- a/google/cloud/functions/framework.h +++ b/google/cloud/functions/framework.h @@ -26,7 +26,7 @@ FUNCTIONS_FRAMEWORK_CPP_INLINE_NAMESPACE_BEGIN /** * Runs function wrapped by @p handler. * - * Starts a HTTP server at the address and listening endpoint described by + * Starts an HTTP server at the address and listening endpoint described by * @p argv, invoking @p handler to handle any HTTP request. * * If @p handler wraps a function with the Cloud Event signature, then the @@ -34,11 +34,11 @@ FUNCTIONS_FRAMEWORK_CPP_INLINE_NAMESPACE_BEGIN * binding specification][cloud-events-spec]. * * @note - * When deploying code to Google Cloud Functions applications should **not** use - * this function directly. The buildpack will automatically create a `main()` - * and invoke `Run()` with the correct parameters. We recommend that application - * developers use this function only for local development and integration - * tests. + * When deploying code to Google Cloud Functions applications should **not** + * call this function directly. The buildpack will automatically create a + * `main()` and invoke `Run()` with the correct parameters. We recommend that + * application developers use this function only for local development and + * integration tests. * * @par Example * @code @@ -64,14 +64,15 @@ int Run(int argc, char const* const argv[], Function const& handler) noexcept; * * @deprecated Prefer using the overload consuming a `Function` object. * - * Starts a HTTP server at the address and listening endpoint described by + * Starts an HTTP server at the address and listening endpoint described by * @p argv, invoking @p handler to handle any HTTP request. * - * When deploying code to Google Cloud Functions applications should **not** use - * this function directly. The buildpack will automatically create a `main()` - * and invoke `Run()` with the correct parameters. We recommend that application - * developers use this function only for local development and integration - * tests. + * @note + * When deploying code to Google Cloud Functions applications should **not** + * call this function directly. The buildpack will automatically create a + * `main()` and invoke `Run()` with the correct parameters. We recommend that + * application developers use this function only for local development and + * integration tests. * * @par Example * @code @@ -94,15 +95,16 @@ int Run(int argc, char const* const argv[], UserHttpFunction handler) noexcept; * * @deprecated Prefer using the overload consuming a `Function` object. * - * Starts a HTTP server at the address and listening endpoint described by + * Starts an HTTP server at the address and listening endpoint described by * @p argv, invoking @p handler to handle any HTTP request which *MUST* conform * to the Cloud Events [HTTP protocol binding][cloud-events-spec]. * - * When deploying code to Google Cloud Functions applications should **not** use - * this function directly. The buildpack will automatically create a `main()` - * and invoke `Run()` with the correct parameters. We recommend that application - * developers use this function only for local development and integration - * tests. + * @note + * When deploying code to Google Cloud Functions applications should **not** + * call this function directly. The buildpack will automatically create a + * `main()` and invoke `Run()` with the correct parameters. We recommend that + * application developers use this function only for local development and + * integration tests. * * @par Example * @code diff --git a/google/cloud/functions/http_request.h b/google/cloud/functions/http_request.h index bacb22ad..53c9827f 100644 --- a/google/cloud/functions/http_request.h +++ b/google/cloud/functions/http_request.h @@ -24,9 +24,9 @@ namespace google::cloud::functions { FUNCTIONS_FRAMEWORK_CPP_INLINE_NAMESPACE_BEGIN /** - * Represents a HTTP request. + * Represents an HTTP request. * - * Functions to handle HTTP requests receive an object of this class. + * Functions to handle HTTP requests receive an object of this type. */ class HttpRequest { public: diff --git a/google/cloud/functions/http_response.h b/google/cloud/functions/http_response.h index f108eab1..88d0c4a6 100644 --- a/google/cloud/functions/http_response.h +++ b/google/cloud/functions/http_response.h @@ -31,9 +31,9 @@ namespace google::cloud::functions { FUNCTIONS_FRAMEWORK_CPP_INLINE_NAMESPACE_BEGIN /** - * Represents a HTTP request. + * Represents an HTTP response. * - * Functions to handle HTTP requests receive an object of this class. + * Functions to handle HTTP requests return an object of this type. */ class HttpResponse { public: