Skip to content
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.

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

doc: remove boilerplate from landing page snippet #10537

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion generator/internal/scaffold_generator.cc
Original file line number Diff line number Diff line change
Expand Up @@ -618,7 +618,7 @@ The following shows the code that you'll run in the
`google/cloud/$library$/quickstart/` directory,
which should give you a taste of the $title$ C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down Expand Up @@ -923,6 +923,7 @@ void GenerateQuickstartSkeleton(
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/$library$/ EDIT HERE .h"
#include "google/cloud/project.h"
#include <iostream>
Expand All @@ -948,6 +949,7 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
)""";
google::protobuf::io::OstreamOutputStream output(&os);
google::protobuf::io::Printer printer(&output, '$');
Expand Down
2 changes: 1 addition & 1 deletion google/cloud/accessapproval/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following shows the code that you'll run in the
`google/cloud/accessapproval/quickstart/` directory,
which should give you a taste of the Access Approval API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/accessapproval/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/accessapproval/access_approval_client.h"
#include "google/cloud/project.h"
#include <iostream>
Expand All @@ -36,3 +37,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/accesscontextmanager/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following shows the code that you'll run in the
`google/cloud/accesscontextmanager/quickstart/` directory,
which should give you a taste of the Access Context Manager API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/accesscontextmanager/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/accesscontextmanager/access_context_manager_client.h"
#include <iostream>

Expand All @@ -36,3 +37,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/apigateway/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The following shows the code that you'll run in the
`google/cloud/apigateway/quickstart/` directory,
which should give you a taste of the API Gateway API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/apigateway/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/apigateway/api_gateway_client.h"
#include <iostream>

Expand All @@ -37,3 +38,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/apigeeconnect/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The following shows the code that you'll run in the
`google/cloud/apigeeconnect/quickstart/` directory,
which should give you a taste of the Apigee Connect API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/apigeeconnect/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/apigeeconnect/connection_client.h"
#include <iostream>

Expand All @@ -37,3 +38,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/apikeys/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The following shows the code that you'll run in the
`google/cloud/apikeys/quickstart/` directory,
which should give you a taste of the API Keys API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/apikeys/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/apikeys/api_keys_client.h"
#include <iostream>

Expand All @@ -35,3 +36,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/appengine/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The following shows the code that you'll run in the
`google/cloud/appengine/quickstart/` directory,
which should give you a taste of the App Engine Admin API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/appengine/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/appengine/services_client.h"
#include <iostream>

Expand All @@ -36,3 +37,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/artifactregistry/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following shows the code that you'll run in the
`google/cloud/artifactregistry/quickstart/` directory,
which should give you a taste of the Artifact Registry API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/artifactregistry/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/artifactregistry/artifact_registry_client.h"
#include <iostream>

Expand All @@ -37,3 +38,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/asset/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following shows the code that you'll run in the
`google/cloud/asset/quickstart/` directory,
which should give you a taste of the Cloud Asset API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/asset/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/asset/asset_client.h"
#include "google/cloud/project.h"
#include <iostream>
Expand Down Expand Up @@ -39,3 +40,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/assuredworkloads/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The following shows the code that you'll run in the
`google/cloud/assuredworkloads/quickstart/` directory,
which should give you a taste of the Assured Workloads API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/assuredworkloads/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/assuredworkloads/assured_workloads_client.h"
#include <iostream>

Expand All @@ -37,3 +38,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/automl/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following shows the code that you'll run in the
`google/cloud/automl/quickstart/` directory,
which should give you a taste of the Cloud AutoML API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/automl/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/automl/auto_ml_client.h"
#include <iostream>

Expand All @@ -36,3 +37,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/baremetalsolution/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following shows the code that you'll run in the
`google/cloud/baremetalsolution/quickstart/` directory,
which should give you a taste of the Bare Metal Solution API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/baremetalsolution/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/baremetalsolution/bare_metal_solution_client.h"
#include <iostream>

Expand All @@ -37,3 +38,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/batch/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following shows the code that you'll run in the
`google/cloud/batch/quickstart/` directory,
which should give you a taste of the Batch API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/batch/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/batch/batch_client.h"
#include <iostream>

Expand All @@ -36,3 +37,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/beyondcorp/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The following shows the code that you'll run in the
`google/cloud/beyondcorp/quickstart/` directory,
which should give you a taste of the BeyondCorp API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/beyondcorp/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/beyondcorp/app_connectors_client.h"
#include <iostream>

Expand All @@ -37,3 +38,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/bigquery/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following shows the code that you'll run in the
`google/cloud/bigquery/quickstart/` directory, which should give you a taste of
the Cloud BigQuery C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all
@endparblock

## Environment Variables
Expand Down
4 changes: 2 additions & 2 deletions google/cloud/bigquery/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [START bigquerystorage_quickstart]
//! [START bigquerystorage_quickstart] [all]
#include "google/cloud/bigquery/bigquery_read_client.h"
#include <iostream>

Expand Down Expand Up @@ -70,4 +70,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [END bigquerystorage_quickstart]
//! [END bigquerystorage_quickstart] [all]
2 changes: 1 addition & 1 deletion google/cloud/bigtable/doc/bigtable-main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following shows the code that you'll run in the
`google/cloud/bigtable/quickstart/` directory,
which should give you a taste of the Cloud Bigtable C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## API Notes

Expand Down
4 changes: 2 additions & 2 deletions google/cloud/bigtable/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

// [START bigtable_quickstart]
//! [START bigtable_quickstart] [all]
#include "google/cloud/bigtable/table.h"

int main(int argc, char* argv[]) try {
Expand Down Expand Up @@ -57,4 +57,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
// [END bigtable_quickstart]
//! [END bigtable_quickstart] [all]
2 changes: 1 addition & 1 deletion google/cloud/billing/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The following shows the code that you'll run in the
`google/cloud/billing/quickstart/` directory,
which should give you a taste of the Cloud Billing Budget API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
2 changes: 2 additions & 0 deletions google/cloud/billing/quickstart/quickstart.cc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! [all]
#include "google/cloud/billing/cloud_billing_client.h"
#include <iostream>

Expand All @@ -35,3 +36,4 @@ int main(int argc, char* argv[]) try {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
//! [all]
2 changes: 1 addition & 1 deletion google/cloud/binaryauthorization/doc/main.dox
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The following shows the code that you'll run in the
`google/cloud/binaryauthorization/quickstart/` directory,
which should give you a taste of the Binary Authorization API C++ client library API.

@include quickstart.cc
@snippet quickstart.cc all

## Environment Variables

Expand Down
Loading