Followup test for checking propagated documentation (paritytech#514)

* codegen: Composite fields docs Signed-off-by: Alexandru Vasile <[email protected]> * codegen: Propagate docs for Event type Signed-off-by: Alexandru Vasile <[email protected]> * codegen: Propagate docs for calls module Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Update polkadot.rs Signed-off-by: Alexandru Vasile <[email protected]> * codegen: Propagate documentation for `TypeDefGenKind::Enum` kind Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Update polkadot.rs Signed-off-by: Alexandru Vasile <[email protected]> * codegen/tests: Recursively obtain raw metadata documentation Signed-off-by: Alexandru Vasile <[email protected]> * codegen/tests: Generate runtime interface from node metadata Signed-off-by: Alexandru Vasile <[email protected]> * codegen/tests: Obtain documentation from generated runtime API Signed-off-by: Alexandru Vasile <[email protected]> * codegen/tests: Match raw documentation with the generated one Signed-off-by: Alexandru Vasile <[email protected]> * Revert not longer needed "codegen: Composite fields docs" This reverts commit 5460bbafc6262ac4f53e11d4ef11e44e1ce8296f. * codegen/tests: Improve test regex documentation Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Add integration-tests feature flag Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Guard integration tests under feature flag Signed-off-by: Alexandru Vasile <[email protected]> * test-runtime: Place build.rs under feature flag Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Pass `integration-tests` feature to `test-runtime` Signed-off-by: Alexandru Vasile <[email protected]> * CI: Use `integration-tests` feature to run all tests Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Rely on `#[cfg(feature = "integration-tests")]` for integration Signed-off-by: Alexandru Vasile <[email protected]> * subxt/metadata: Manually construct test metadata Signed-off-by: Alexandru Vasile <[email protected]> * artifacts: Move scale binary blob to dedicated folder Signed-off-by: Alexandru Vasile <[email protected]> * examples: Update path to metadata blob Signed-off-by: Alexandru Vasile <[email protected]> * metadata: Rely on artifact metadata blob for benches Signed-off-by: Alexandru Vasile <[email protected]> * metadata: Remove `test-runtime` dependency Signed-off-by: Alexandru Vasile <[email protected]> * examples: Modify runtime path for `custom_type_derives` Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Remove tests folder Signed-off-by: Alexandru Vasile <[email protected]> * test-runtime: Remove `integration-tests` feature flag Signed-off-by: Alexandru Vasile <[email protected]> * integration-tests: Add an integration test crate for subxt Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Remove `test-runtime` dependency Signed-off-by: Alexandru Vasile <[email protected]> * subxt: Add comment for feature flags Signed-off-by: Alexandru Vasile <[email protected]> * integration-tests: Trim dependencies Signed-off-by: Alexandru Vasile <[email protected]> * integration-tests: Move dependencies under dev Signed-off-by: Alexandru Vasile <[email protected]> * Revert "CI: Use `integration-tests` feature to run all tests" This reverts commit 8e5f38ba8c633ac40420fadf58700ac402f762d4. * codegen: Move documentation test to integration crate Signed-off-by: Alexandru Vasile <[email protected]> * codegen_documentation: Add license + fmt Signed-off-by: Alexandru Vasile <[email protected]> * Update `polkadot.rs` Signed-off-by: Alexandru Vasile <[email protected]> * Move test under `testing` folder Signed-off-by: Alexandru Vasile <[email protected]> * Update testing/integration-tests/src/codegen/codegen_documentation.rs Co-authored-by: Tarik Gul <[email protected]> Co-authored-by: Tarik Gul <[email protected]>
boolnetwork · Jun 17, 2022 · 0d67b80 · 0d67b80
1 parent cb18ad7
commit 0d67b80
Show file tree

Hide file tree

Showing 10 changed files with 565 additions and 688 deletions.
diff --git a/codegen/src/api/calls.rs b/codegen/src/api/calls.rs
@@ -154,7 +154,11 @@ pub fn generate_calls(
         })
         .unzip();
 
+    let call_ty = type_gen.resolve_type(call.ty.id());
+    let docs = call_ty.docs();
+
     quote! {
+        #( #[doc = #docs ] )*
         pub mod calls {
             use super::root_mod;
             use super::#types_mod_ident;

diff --git a/codegen/src/api/events.rs b/codegen/src/api/events.rs
@@ -81,8 +81,11 @@ pub fn generate_events(
         }
     });
     let event_type = type_gen.resolve_type_path(event.ty.id(), &[]);
+    let event_ty = type_gen.resolve_type(event.ty.id());
+    let docs = event_ty.docs();
 
     quote! {
+        #( #[doc = #docs ] )*
         pub type Event = #event_type;
         pub mod events {
             use super::#types_mod_ident;

diff --git a/codegen/src/types/type_def.rs b/codegen/src/types/type_def.rs
@@ -46,6 +46,8 @@ pub struct TypeDefGen {
     derives: Derives,
     /// The kind of type to be generated.
     ty_kind: TypeDefGenKind,
+    /// Type documentation.
+    ty_docs: TokenStream,
 }
 
 impl TypeDefGen {
@@ -119,10 +121,14 @@ impl TypeDefGen {
             _ => TypeDefGenKind::BuiltIn,
         };
 
+        let docs = ty.docs();
+        let ty_docs = quote! { #( #[doc = #docs ] )* };
+
         Self {
             type_params,
             derives,
             ty_kind,
+            ty_docs,
         }
     }
 }
@@ -152,8 +158,10 @@ impl quote::ToTokens for TypeDefGen {
                 let enum_ident = format_ident!("{}", type_name);
                 let type_params = &self.type_params;
                 let derives = &self.derives;
+                let docs = &self.ty_docs;
                 let ty_toks = quote! {
                     #derives
+                    #docs
                     pub enum #enum_ident #type_params {
                         #( #variants, )*
                     }

diff --git a/integration-tests/Cargo.toml b/integration-tests/Cargo.toml
diff --git a/integration-tests/src/lib.rs b/integration-tests/src/lib.rs