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.

Sign up for GitHub

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

Jump to bottom

protoc-gen-go: indicate deprecated fields in documentation #506

Merged
merged 1 commit into from
Feb 3, 2018
Merged

protoc-gen-go: indicate deprecated fields in documentation #506

merged 1 commit into from
Feb 3, 2018

Commits on Feb 2, 2018

  1. protoc-gen-go: indicate deprecated fields in documentation 

    Tools in the Go ecosystem treat code documented with "Deprecated:"
as special for purposes of warning users not to use them.  When a file,
message, field, enum, enum value, service, or method is marked as
deprecated, the generator will emit "// Deprecated: Do not use."
comments on all relevant exported Go package information related to
the deprecated element.

This is an outline of how deprecation of each element effects the generated proto:
* file - a comment is added to the top of the generated proto.
* message - a comment is added above its type definition.
* field, enum, or enum value - a comment is added inline with the defintion.
* field - an additional comment is added above the field Getter.
* service - a comment is added above generated Client interface and New method.
* service - a comment is added above generated Server interface and Registration method.
* method - a comment is added above the generated method definition.

Fixes #396.
    Chris Manghane committed Feb 2, 2018
    Configuration menu
    Copy the full SHA
    da3e237 View commit details
    Browse the repository at this point in the history