diff --git a/README.md b/README.md index c3750ab..15d3bf7 100644 --- a/README.md +++ b/README.md @@ -217,6 +217,6 @@ terms or conditions. [`tonic-examples`]: https://github.com/hyperium/tonic/tree/master/tonic-examples [`tonic-interop`]: https://github.com/hyperium/tonic/tree/master/tonic-interop [Examples]: https://github.com/hyperium/tonic/tree/master/tonic-examples -[Website]: https://tokio.rs +[Website]: https://github.com/hyperium/tonic [Docs]: https://docs.rs/tonic [Chat]: https://discord.gg/6yGkFeN diff --git a/tonic/src/client/service.rs b/tonic/src/client/service.rs index cd66706..c7511ed 100644 --- a/tonic/src/client/service.rs +++ b/tonic/src/client/service.rs @@ -4,10 +4,13 @@ use std::future::Future; use std::task::{Context, Poll}; use tower_service::Service; -/// Definition of the gRPC trait alias for [`tower_service::Service`]. +/// Definition of the gRPC trait alias for [`tower_service`]. /// /// This trait enforces that all tower services provided to [`Grpc`] implements /// the correct traits. +/// +/// [`Grpc`]: ../client/struct.Grpc.html +/// [`tower_service`]: https://docs.rs/tower-service pub trait GrpcService { /// Responses body given by the service. type ResponseBody: Body + HttpBody; diff --git a/tonic/src/codec/mod.rs b/tonic/src/codec/mod.rs index b75fea5..5859223 100644 --- a/tonic/src/codec/mod.rs +++ b/tonic/src/codec/mod.rs @@ -11,6 +11,7 @@ mod prost; pub use self::decode::Streaming; pub(crate) use self::encode::{encode_client, encode_server}; #[cfg(feature = "prost")] +#[cfg_attr(docsrs, doc(cfg(feature = "prost")))] pub use self::prost::ProstCodec; pub use tokio_codec::{Decoder, Encoder}; diff --git a/tonic/src/metadata/key.rs b/tonic/src/metadata/key.rs index 3fe0b68..5a919d3 100644 --- a/tonic/src/metadata/key.rs +++ b/tonic/src/metadata/key.rs @@ -13,6 +13,7 @@ use super::encoding::{Ascii, Binary, ValueEncoding}; /// `MetadataKey` is used as the [`MetadataMap`] key. /// /// [`HeaderMap`]: struct.HeaderMap.html +/// [`MetadataMap`]: struct.MetadataMap.html #[derive(Clone, Eq, PartialEq, Hash)] #[repr(transparent)] pub struct MetadataKey { diff --git a/tonic/src/metadata/value.rs b/tonic/src/metadata/value.rs index c96f24f..44cedc5 100644 --- a/tonic/src/metadata/value.rs +++ b/tonic/src/metadata/value.rs @@ -15,6 +15,7 @@ use std::{cmp, fmt}; /// `MetadataValue` is used as the [`MetadataMap`] value. /// /// [`HeaderMap`]: struct.HeaderMap.html +/// [`MetadataMap`]: struct.MetadataMap.html #[derive(Clone, Hash)] #[repr(transparent)] pub struct MetadataValue {