fix(proc macros): generate documentation for trait methods. #453

niklasad1 · 2021-09-07T09:24:59Z

Closing #449

Note, we are not using the docs on the entire trait instead we are manually inserting documentation there but for that we need to parse the TraitItem for that so out-of-scope for this PR.

To elaborate if you do:

/// My import API but these comments are not used anywhere
#[rpc(client, server)]
pub trait MyApi {
	/// API.
	#[method(name = "api"]
	async fn api(&self) -> jsonrpsee::types::JsonRpcResult<()>;
}

Expands to

///Server trait implementation for the `Rpc` RPC API.
pub trait MyApiServer: Sized + Send + Sync + 'static
{
    /// API
    async fn api(&self) { ....}
}

///Client implementation for the `Rpc` RPC API.
pub trait RpcClient: jsonrpsee::types::traits::Client
{
    /// API
    async fn api(&self) { ....}
}

Fixes #449

dvdplm

lgtm!

proc-macros/src/helpers.rs

proc-macros/src/rpc_macro.rs

maciejhirsz

Looks good, just one nit.

proc-macros/src/helpers.rs

niklasad1 · 2021-09-08T09:46:16Z

proc-macros/src/helpers.rs

+/// Note that `doc comments` are expanded into `#[doc = "some comment"]`
+/// Thus, if the attribute starts with `doc` => it's regarded as a doc comment.
+pub(crate) fn extract_doc_comments(attrs: &[syn::Attribute]) -> TokenStream2 {
+	let docs = attrs.iter().filter(|attr| attr.path.is_ident("doc")).filter(|attr| match attr.parse_meta() {


I'm not super happy with the formatting of this one but it's better then previous version at least.....

Could have been .filter(|attr| attr.path.is_ident("doc") && match ... 🙈

🥶 I can fix it in an follow up PR

* cleanup * Update ws-server/src/tests.rs * Update http-server/src/tests.rs

niklasad1 added 3 commits September 7, 2021 11:09

fix(proc macros): generate documentation

3db4a82

Fixes #449

revert proc macro example

a87a82e

add test that docs are generated

a9517b6

niklasad1 requested review from dvdplm and maciejhirsz September 7, 2021 09:25

use import

1917c33

dvdplm approved these changes Sep 7, 2021

View reviewed changes

proc-macros/src/helpers.rs Outdated Show resolved Hide resolved

proc-macros/src/rpc_macro.rs Outdated Show resolved Hide resolved

proc-macros/src/rpc_macro.rs Outdated Show resolved Hide resolved

proc-macros/src/rpc_macro.rs Outdated Show resolved Hide resolved

niklasad1 added 3 commits September 7, 2021 12:57

address grumbles

1a6da08

make the code less ugly

1672d0f

simplify more

606cbbf

dvdplm approved these changes Sep 8, 2021

View reviewed changes

maciejhirsz approved these changes Sep 8, 2021

View reviewed changes

proc-macros/src/helpers.rs Outdated Show resolved Hide resolved

fix grumbles: check ident before parse

0f5ce55

maciejhirsz reviewed Sep 8, 2021

View reviewed changes

proc-macros/src/helpers.rs Outdated Show resolved Hide resolved

maciejhirsz reviewed Sep 8, 2021

View reviewed changes

proc-macros/src/helpers.rs Outdated Show resolved Hide resolved

more grumbles: filter_map -> filter

da482ef

niklasad1 commented Sep 8, 2021

View reviewed changes

niklasad1 merged commit 089aa11 into master Sep 8, 2021

niklasad1 deleted the na-proc-macros-generate-docs branch September 8, 2021 09:57

niklasad1 mentioned this pull request Sep 8, 2021

cleanup after #453 #454

Merged

niklasad1 added a commit that referenced this pull request Sep 8, 2021

cleanup after #453 (#454)

b6d93d2

* cleanup * Update ws-server/src/tests.rs * Update http-server/src/tests.rs

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(proc macros): generate documentation for trait methods. #453

fix(proc macros): generate documentation for trait methods. #453

niklasad1 commented Sep 7, 2021 •

edited

Loading

dvdplm left a comment

maciejhirsz left a comment

niklasad1 Sep 8, 2021

maciejhirsz Sep 8, 2021

niklasad1 Sep 8, 2021 •

edited

Loading

fix(proc macros): generate documentation for trait methods. #453

fix(proc macros): generate documentation for trait methods. #453

Conversation

niklasad1 commented Sep 7, 2021 • edited Loading

dvdplm left a comment

Choose a reason for hiding this comment

maciejhirsz left a comment

Choose a reason for hiding this comment

niklasad1 Sep 8, 2021

Choose a reason for hiding this comment

maciejhirsz Sep 8, 2021

Choose a reason for hiding this comment

niklasad1 Sep 8, 2021 • edited Loading

Choose a reason for hiding this comment

niklasad1 commented Sep 7, 2021 •

edited

Loading

niklasad1 Sep 8, 2021 •

edited

Loading