[Rust] Add support for module comments (#4028)

fable-compiler · Feb 5, 2025 · ffc6ee9 · ffc6ee9
1 parent e381f0a
commit ffc6ee9
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 1 deletion.
diff --git a/src/Fable.AST/CHANGELOG.md b/src/Fable.AST/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+* [All] Add support for module comments (by @ncave)
+
 ## 4.6.0 - 2025-01-28
 
 * Stable release

diff --git a/src/Fable.AST/Fable.fs b/src/Fable.AST/Fable.fs
@@ -441,6 +441,7 @@ type ModuleDecl =
         Name: string
         Entity: EntityRef
         Members: Declaration list
+        XmlDoc: string option
     }
 
 and Declaration =

diff --git a/src/Fable.Cli/CHANGELOG.md b/src/Fable.Cli/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * [Python] - Print root module and module function comments (by @alfonsogarciacaro)
+* [Rust] Add support for module comments (by @ncave)
 * [Rust] Add support for null strings (by @ncave)
 
 ## 5.0.0-alpha.9 - 2025-01-28

diff --git a/src/Fable.Compiler/CHANGELOG.md b/src/Fable.Compiler/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 * [Python] - Print root module and module function comments (by @alfonsogarciacaro)
+* [Rust] Add support for module comments (by @ncave)
 * [Rust] Add support for null strings (by @ncave)
 
 ## 5.0.0-alpha.9 - 2025-01-28

diff --git a/src/Fable.Transforms/FSharp2Fable.fs b/src/Fable.Transforms/FSharp2Fable.fs
@@ -2080,6 +2080,7 @@ let rec private transformDeclarations (com: FableCompiler) ctx fsDecls =
                             Name = fsEnt.CompiledName
                             Entity = entRef
                             Members = members
+                            XmlDoc = tryGetXmlDoc fsEnt.XmlDoc
                         }
                 ]
             | sub -> transformDeclarations com ctx sub

diff --git a/src/Fable.Transforms/Rust/Fable2Rust.fs b/src/Fable.Transforms/Rust/Fable2Rust.fs
@@ -5095,7 +5095,7 @@ module Util =
                 com.ClearAllImports(ctx)
                 useItem :: importItems
 
-            let outerAttrs = transformAttributes com ctx ent.Attributes None
+            let outerAttrs = transformAttributes com ctx ent.Attributes decl.XmlDoc
             let innerAttrs = getInnerAttributes com ctx decl.Members
             let attrs = innerAttrs @ outerAttrs
             let modDecls = useDecls @ memberDecls