mirrors/salsa
1
0
Fork 0
mirror of https://github.com/salsa-rs/salsa.git synced 2025-01-27 15:07:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Improve doc comments

Browse source
This commit is contained in:
Roberto Vidal 2019-04-06 14:22:31 +02:00
parent c39ce43050
commit 01c03b85b1
1 changed files with 24 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
components/salsa-macros/src/query_group.rs
View file

@ -208,24 +208,33 @@ pub(crate) fn query_group(args: TokenStream, input: TokenStream) -> TokenStream
let set_constant_fn_name =
Ident::new(&format!("set_constant_{}", fn_name), fn_name.span());
let set_fn_docs = format!("
Set the value of the `{fn_name}` input.
See `{fn_name}` for details.
*Note:* Setting values will trigger cancellation
of any ongoing queries; this method blocks until
those queries have been cancelled.
", fn_name = fn_name);
let set_constant_fn_docs = format!("
Set the value of the `{fn_name}` input and promise
that its value will never change again.
See `{fn_name}` for details.
*Note:* Setting values will trigger cancellation
of any ongoing queries; this method blocks until
those queries have been cancelled.
", fn_name = fn_name);
query_fn_declarations.extend(quote! {
/// Set the value of the `#fn_name` input.
///
/// See [`#fn_name()`][] for details.
///
/// *Note:* Setting values will trigger cancellation
/// of any ongoing queries; this method blocks until
/// those queries have been cancelled.
# [doc = #set_fn_docs]
fn #set_fn_name(&mut self, #(#key_names: #keys,)* value__: #value);
/// Set the value of the `#fn_name` input and promise
/// that its value will never change again.
///
/// See [`#fn_name()`][] for details.
///
/// *Note:* Setting values will trigger cancellation
/// of any ongoing queries; this method blocks until
/// those queries have been cancelled.
# [doc = #set_constant_fn_docs]
fn #set_constant_fn_name(&mut self, #(#key_names: #keys,)* value__: #value);
});