feat(build): add cleanup-markdown feature flag (#1086)

2022-09-28 10:00:25 -04:00
parent 56ff45d9a3
commit c1b08dffac
4 changed files with 64 additions and 52 deletions
@@ -1,6 +1,14 @@
 //! `tonic-build` compiles `proto` files via `prost` and generates service stubs
 //! and proto definitiones for use with `tonic`.
 //!
+//! # Feature flags
+//!
+//! - `cleanup-markdown`: Enables cleaning up documentation from the generated code. Useful
+//! when documentation of the generated code fails `cargo test --doc` for example.
+//! - `prost`: Enables usage of prost generator (enabled by default).
+//! - `transport`: Enables generation of `connect` method using `tonic::transport::Channel`
+//! (enabled by default).
+//!
 //! # Required dependencies
 //!
 //! ```toml