README
¶
This directory contains tools to run the sample generator in ../toolkit/ and the client library generators in clients/.
To get started, execute ./setup in this directory.
Directories
¶
| Path | Synopsis |
|---|---|
|
common
|
|
|
clone
Package clone implements a generic Clone() operation applicable to all types.
|
Package clone implements a generic Clone() operation applicable to all types. |
|
environment
Package environment returns information about the environment in which this binary executes.
|
Package environment returns information about the environment in which this binary executes. |
|
errorlist
Package errorlist maintains a list of errors that clients can populate and later retrieve, in order to present multiple errors to the user at once (as opposed to causing piecemeal incremental failures as the user fixes one error and re-runs).
|
Package errorlist maintains a list of errors that clients can populate and later retrieve, in order to present multiple errors to the user at once (as opposed to causing piecemeal incremental failures as the user fixes one error and re-runs). |
|
gcs
Package gcs allows users to run the gsutil command to upload data to Google Cloud storage.
|
Package gcs allows users to run the gsutil command to upload data to Google Cloud storage. |
|
parsehtml
Package parsehtml provides utilities for parsing HTML-format library documentation, which is referenced for type information by the Python "compile" check.
|
Package parsehtml provides utilities for parsing HTML-format library documentation, which is referenced for type information by the Python "compile" check. |
|
main
|
|
|
update
Package update provides the top-level `Update` function to refresh and regenerate artifacts in discovery-artifact-manager
|
Package update provides the top-level `Update` function to refresh and regenerate artifacts in discovery-artifact-manager |
|
updatedisco
Package main provides a standalone executable `updatedisco` to update the local Discovery doc cache from the live Discovery service in a top-level directory 'discoveries', which must exist.
|
Package main provides a standalone executable `updatedisco` to update the local Discovery doc cache from the live Discovery service in a top-level directory 'discoveries', which must exist. |
|
snippetgen
|
|
|
common/clientlib
Package clientlib provides utility functions to help with downloading client libraries.
|
Package clientlib provides utility functions to help with downloading client libraries. |
|
common/fragment
Package fragment defines the format of the fragment files that will eventually be displayed on documentation pages.
|
Package fragment defines the format of the fragment files that will eventually be displayed on documentation pages. |
|
common/metadata
Package metadata contains utility functions as well as run-time constants for creating the fragment files.
|
Package metadata contains utility functions as well as run-time constants for creating the fragment files. |
|
compilecheck
compilecheck sets up tests to check the validity of generated code samples.
|
compilecheck sets up tests to check the validity of generated code samples. |
|
compilecheck/internal/csharp
Package csharp implements compile checking for C#.code samples.
|
Package csharp implements compile checking for C#.code samples. |
|
compilecheck/internal/filesys
Package filesys contains abstractions and mocks of the file system, useful for testing.
|
Package filesys contains abstractions and mocks of the file system, useful for testing. |
|
compilecheck/internal/golang
Package golang implements compile checking for Go code samples.
|
Package golang implements compile checking for Go code samples. |
|
compilecheck/internal/java
Package java implements compilecheck for Java.
|
Package java implements compilecheck for Java. |
|
compilecheck/internal/js
Package js implements compilecheck for JS.
|
Package js implements compilecheck for JS. |
|
compilecheck/internal/langutil
Package langutil provides language-independent types useful for processing code snippets and client libraries.
|
Package langutil provides language-independent types useful for processing code snippets and client libraries. |
|
compilecheck/internal/nodejs
Package nodejs implements compilecheck for NodeJS.
|
Package nodejs implements compilecheck for NodeJS. |
|
compilecheck/internal/php
Package php implements compilecheck for PHP.
|
Package php implements compilecheck for PHP. |
|
compilecheck/internal/py
Package py implements compilecheck for Python.
|
Package py implements compilecheck for Python. |
|
compilecheck/internal/ruby
Package ruby implements compilecheck for Ruby.
|
Package ruby implements compilecheck for Ruby. |
|
jsonpkger
Jsonpkger packages code fragments into JSON form.
|
Jsonpkger packages code fragments into JSON form. |
|
mergesnippets
Package main contains the main driver for the mergesnippets tool, which merges manual and automatic snippets into public snippets that can be published to GCS.
|
Package main contains the main driver for the mergesnippets tool, which merges manual and automatic snippets into public snippets that can be published to GCS. |
|
mergesnippets/snippet
Package snippet implements the Merger class to retrieve and merge secondary and primary snippets, and to publish the merged snippets.
|
Package snippet implements the Merger class to retrieve and merge secondary and primary snippets, and to publish the merged snippets. |
Click to show internal directories.
Click to hide internal directories.