Use /** and /// comments for doc generation #52
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ZackButcher
approved these changes
Mar 2, 2017
ZackButcher
reviewed
Mar 2, 2017
| // testing the failure recovery capabilities of downstream services. | ||
| // Faults include terminating established Tcp connections, throttling the | ||
| // upstream/downstream bandwidth (for Tcp|Udp), or both. | ||
| // Faults can be injected into the connections from downstream by the |
There was a problem hiding this comment.
Should this have 3 slashes?
There was a problem hiding this comment.
Intentionally done. We dont want to generate docs for these publicly yet because they are not implemented. As far as proto is concerned, there are still comments.
ZackButcher
reviewed
Mar 2, 2017
| oneof error_type { | ||
| string grpc_status = 2; | ||
| string http2_error = 3; | ||
| uint32 http_status = 4; | ||
| int32 http_status = 4; | ||
| } | ||
| // Specify abort code as part of Http request. |
There was a problem hiding this comment.
Actually, sorry. This was also left out intentionally, as we don't support these yet. We dont want users to get confused about stuff that is unimplemented.
kyessenov
approved these changes
Mar 2, 2017
added 2 commits
March 2, 2017 00:24
incfly
pushed a commit
to incfly/api
that referenced
this pull request
Jun 13, 2018
* Move prefetch codes into its own folder. * Add prefetch/BUILD. * Update include quard. * Update comment to trigger a PR test.
nacx
pushed a commit
to nacx/api
that referenced
this pull request
Feb 23, 2022
* Control plane updates (istio#49) * Control plane updates Signed-off-by: Liam White <[email protected]> * fix merge mistakes Signed-off-by: Liam White <[email protected]> * fix telem store comments Signed-off-by: Liam White <[email protected]> * docs: Fix single-tick (istio#50) Signed-off-by: Dhi Aurrahman <[email protected]> * add protocol to elastic settings (istio#51) * add protocol to elastic settings Signed-off-by: Liam White <[email protected]> * gogo Signed-off-by: Liam White <[email protected]> * generate fixes Signed-off-by: Liam White <[email protected]> * Add job annotations for components with jobs (istio#52) * Add container port and service types + refactor (istio#56) * Add container port and service types + refactor Signed-off-by: Liam White <[email protected]> * makefile and comment touch-ups Signed-off-by: Liam White <[email protected]> * Make Istio install atomic and add more currently used fields (istio#61) * Fix TLS capitalization (istio#62) * Add proto for some more postgres configuration (istio#53) * Add proto for some more postgres configuration * Address comments * More comments * Add Escape Hatch for users with weird edge cases (istio#65) Also need to move back to golang protobuf in order to re-use the Istio patch framework. * Use older Istio API to avoid breaking dp operator (istio#66) * Postgres SSL settings (istio#67) * Postgres SSL settings * Update install/managementplane/v1alpha1/settings.proto Co-authored-by: Liam White <[email protected]> * Update install/managementplane/v1alpha1/settings.proto Co-authored-by: Liam White <[email protected]> * Add remaining SSL modes Co-authored-by: Liam White <[email protected]> * Configure CNI (istio#68) * Configure CNI * review Signed-off-by: Liam White <[email protected]> * Add CNI config file name, used when chained is false Co-authored-by: Liam White <[email protected]> * Revert "Postgres SSL settings (istio#67)" (istio#70) * Revert "Postgres SSL settings (istio#67)" This reverts commit 391889fdaf5bfa3996c85719975df1c44ce94102. * Add back all ssl modes * Doc Fixes for Install API (istio#71) * ci: Add check (istio#73) This patch brings the check script to release-0.8.0. Seems like this is the new "master". Signed-off-by: Dhi Aurrahman <[email protected]> * docs: Add types frontmatter (istio#74) This adds types frontmatter data to types.proto. Until we have an automated way to populate title, we are encouraged to add a title when it is desired. Signed-off-by: Dhi Aurrahman <[email protected]> * Postgres SSL mode default to require (istio#75) * Autogen JSON shims (istio#80) * nits * Update install readme (istio#85) * Add ES version to settings (istio#88) * Add ES version to settings * ES version int with validation Co-authored-by: Liam White <[email protected]> Co-authored-by: Dhi Aurrahman <[email protected]> Co-authored-by: Vikas Choudhary (vikasc) <[email protected]> Co-authored-by: Marc Cirauqui <[email protected]> This PR merges the release_0.8.0 (as of commit - d3a19fdd8d25cdd8f386c4a4a2a821daa9865df0) branch into master. operator protos needs go_plugin instead of gogofast_plugin for the protoc. It is as is merge otherwise.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.