| commit | 9a408a7ef0591d5e04dc651f8888b6850cee0ee1 | [log] [tgz] |
|---|---|---|
| author | Ömer Sinan Ağacan <omersa@google.com> | Mon Jan 08 12:12:23 2024 +0100 |
| committer | GitHub <noreply@github.com> | Mon Jan 08 12:12:23 2024 +0100 |
| tree | e0628f8ab07f7434979b928edc00923af0c1f00f | |
| parent | c4fd596252e0467c1ee2a2f1832c561399efd5a2 [diff] |
Generate docs of enums and rpc clients, some refactoring (#909) This implements generating doc comments for enum types, enum values, rpc types, and rpc methods. Existing code for generating doc comments is refactored: the comment generator handles trailing whitespace so we don't have to handle it in the call sites. Comment generator is documented with the invariants: it never returns an empty string (returns `null` instead) and never returns lines with trailing whitespace. To be able to test comment generating, a new kind of golden file test is added. The difference from the other golden file tests is that this file is compiled from .proto source instead of from a hand-crafted descriptor. This is because attaching comments to proto field and types by hand is difficult and error prone. Fixes the comment part of #900.
Protocol Buffers (protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data.
This repository is home to packages related to protobuf for Dart.
| Package | Description | Published Version |
|---|---|---|
| protobuf | A support library for the generated code |  |
| protoc_plugin | A Dart back-end for the protoc compiler |  |
| api_benchmark | Benchmarking for various API calls | |
| query_benchmark | Benchmark for encoding and decoding of a “real-world” protobuf |
For information about our publishing automation and release process, see https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.