Mark top level module as a crate in rustdoc, closes rust-lang#12507

francoisthire · Feb 26, 2014 · 5d825de · 5d825de
1 parent 68a92c5
commit 5d825de
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 2 deletions.
diff --git a/src/librustdoc/clean.rs b/src/librustdoc/clean.rs
@@ -186,6 +186,7 @@ pub enum ItemEnum {
 #[deriving(Clone, Encodable, Decodable)]
 pub struct Module {
     items: ~[Item],
+    is_crate: bool,
 }
 
 impl Clean<Item> for doctree::Module {
@@ -202,6 +203,7 @@ impl Clean<Item> for doctree::Module {
             visibility: self.vis.clean(),
             id: self.id,
             inner: ModuleItem(Module {
+               is_crate: self.is_crate,
                items: [self.structs.clean(), self.enums.clean(),
                        self.fns.clean(), self.foreigns.clean().concat_vec(),
                        self.mods.clean(), self.typedefs.clean(),

diff --git a/src/librustdoc/doctree.rs b/src/librustdoc/doctree.rs
@@ -33,6 +33,7 @@ pub struct Module {
     foreigns: ~[ast::ForeignMod],
     view_items: ~[ast::ViewItem],
     macros: ~[Macro],
+    is_crate: bool,
 }
 
 impl Module {
@@ -54,6 +55,7 @@ impl Module {
             view_items : ~[],
             foreigns   : ~[],
             macros     : ~[],
+            is_crate   : false,
         }
     }
 }

diff --git a/src/librustdoc/fold.rs b/src/librustdoc/fold.rs
@@ -87,7 +87,10 @@ pub trait DocFolder {
     }
 
     fn fold_mod(&mut self, m: Module) -> Module {
-        Module { items: m.items.move_iter().filter_map(|i| self.fold_item(i)).collect() }
+        Module {
+            is_crate: m.is_crate,
+            items: m.items.move_iter().filter_map(|i| self.fold_item(i)).collect()
+        }
     }
 
     fn fold_crate(&mut self, mut c: Crate) -> Crate {

diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs
@@ -863,7 +863,11 @@ impl<'a> fmt::Show for Item<'a> {
         // Write the breadcrumb trail header for the top
         try!(write!(fmt.buf, "<h1 class='fqn'>"));
         match self.item.inner {
-            clean::ModuleItem(..) => try!(write!(fmt.buf, "Module ")),
+            clean::ModuleItem(ref m) => if m.is_crate {
+                    try!(write!(fmt.buf, "Crate "));
+                } else {
+                    try!(write!(fmt.buf, "Module "));
+                },
             clean::FunctionItem(..) => try!(write!(fmt.buf, "Function ")),
             clean::TraitItem(..) => try!(write!(fmt.buf, "Trait ")),
             clean::StructItem(..) => try!(write!(fmt.buf, "Struct ")),

diff --git a/src/librustdoc/visit_ast.rs b/src/librustdoc/visit_ast.rs
@@ -44,6 +44,7 @@ impl<'a> RustdocVisitor<'a> {
         self.module = self.visit_mod_contents(krate.span, krate.attrs.clone(),
                                               ast::Public, ast::CRATE_NODE_ID,
                                               &krate.module, None);
+        self.module.is_crate = true;
     }
 
     pub fn visit_struct_def(&mut self, item: &ast::Item, sd: @ast::StructDef,