diff --git a/src/api/mod.rs b/src/api/mod.rs index d8b3eb03..dc56d608 100644 --- a/src/api/mod.rs +++ b/src/api/mod.rs @@ -332,6 +332,10 @@ impl ToTokens for Api { } }; + let endpoint_doc = format!("The `{}` API endpoint.\n\n{}", name, description); + let request_doc = format!("Data for a request to the `{}` API endpoint.", name); + let response_doc = format!("Data in the response from the `{}` API endpoint.", name); + let api = quote! { #[allow(unused_imports)] use ::futures::{Future as _, IntoFuture as _, Stream as _}; @@ -341,10 +345,11 @@ impl ToTokens for Api { use ::std::convert::{TryInto as _}; - /// The API endpoint. + #[doc = #endpoint_doc] #[derive(Debug)] pub struct Endpoint; + #[doc = #request_doc] #request_types impl ::std::convert::TryFrom<::http::Request>> for Request { @@ -412,6 +417,7 @@ impl ToTokens for Api { } } + #[doc = #response_doc] #response_types impl ::std::convert::TryFrom for ::http::Response<::hyper::Body> { @@ -457,7 +463,7 @@ impl ToTokens for Api { type Request = Request; type Response = Response; - /// Metadata for this endpoint. + /// Metadata for the `#name` endpoint. const METADATA: ::ruma_api::Metadata = ::ruma_api::Metadata { description: #description, method: ::http::Method::#method, diff --git a/src/api/request.rs b/src/api/request.rs index af2cb2d3..67d26968 100644 --- a/src/api/request.rs +++ b/src/api/request.rs @@ -250,7 +250,6 @@ impl From> for Request { impl ToTokens for Request { fn to_tokens(&self, tokens: &mut TokenStream) { let request_struct_header = quote! { - /// Data for a request to this API endpoint. #[derive(Debug, Clone)] pub struct Request }; diff --git a/src/api/response.rs b/src/api/response.rs index d860ed39..7405338a 100644 --- a/src/api/response.rs +++ b/src/api/response.rs @@ -236,7 +236,6 @@ impl From> for Response { impl ToTokens for Response { fn to_tokens(&self, tokens: &mut TokenStream) { let response_struct_header = quote! { - /// Data in the response from this API endpoint. #[derive(Debug, Clone)] pub struct Response };