Export codegen::TypeGenerator (paritytech#444)

* Export codegen::TypeGenerator * Export Module and add comments to public methods * Fmt
boolnetwork · Feb 12, 2022 · 7615b25 · 7615b25
1 parent 4bed7eb
commit 7615b25
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/codegen/src/lib.rs b/codegen/src/lib.rs
@@ -25,5 +25,9 @@ pub use self::{
         generate_runtime_api,
         RuntimeGenerator,
     },
-    types::GeneratedTypeDerives,
+    types::{
+        GeneratedTypeDerives,
+        Module,
+        TypeGenerator,
+    },
 };
diff --git a/codegen/src/types/mod.rs b/codegen/src/types/mod.rs
@@ -221,6 +221,7 @@ impl<'a> TypeGenerator<'a> {
     }
 }
 
+/// Represents a Rust `mod`, containing generated types and child `mod`s.
 #[derive(Debug)]
 pub struct Module<'a> {
     name: Ident,
@@ -248,7 +249,8 @@ impl<'a> ToTokens for Module<'a> {
 }
 
 impl<'a> Module<'a> {
-    pub fn new(name: Ident, root_mod: Ident) -> Self {
+    /// Create a new [`Module`], with a reference to the root `mod` for resolving type paths.
+    pub(crate) fn new(name: Ident, root_mod: Ident) -> Self {
         Self {
             name,
             root_mod,