about summary refs log tree commit diff
path: root/src/librustdoc/html/render.rs
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2014-08-04 13:53:33 -0700
committerBrian Anderson <banderson@mozilla.com>2014-08-04 14:37:06 -0700
commit08d44f5512e624eadfedf32d41f19ece13dd5fb4 (patch)
treeedf8599b1911f58dcf5d71a1b2e02a3a6bf7295f /src/librustdoc/html/render.rs
parentefe1f7ee9efb5da5613f2cff4f9b810d2d5992d4 (diff)
downloadrust-08d44f5512e624eadfedf32d41f19ece13dd5fb4.tar.gz
rust-08d44f5512e624eadfedf32d41f19ece13dd5fb4.zip
rustdoc: Use more descriptive description metadata.
This text appears in and improves search results.

cc #12466
Diffstat (limited to 'src/librustdoc/html/render.rs')
-rw-r--r--src/librustdoc/html/render.rs20
1 files changed, 19 insertions, 1 deletions
diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs
index 1700354e329..47e91470612 100644
--- a/src/librustdoc/html/render.rs
+++ b/src/librustdoc/html/render.rs
@@ -742,8 +742,10 @@ impl<'a> SourceCollector<'a> {
         let mut w = BufferedWriter::new(try!(File::create(&cur)));
 
         let title = format!("{} -- source", cur.filename_display());
+        let desc = format!("Source to the Rust file `{}`.", filename);
         let page = layout::Page {
             title: title.as_slice(),
+            description: desc.as_slice(),
             ty: "source",
             root_path: root_path.as_slice(),
         };
@@ -1072,8 +1074,11 @@ impl Context {
             try!(stability.encode(&mut json::Encoder::new(&mut json_out)));
 
             let title = stability.name.clone().append(" - Stability dashboard");
+            let desc = format!("API stability overview for the Rust `{}` crate.",
+                               this.layout.krate);
             let page = layout::Page {
                 ty: "mod",
+                description: desc.as_slice(),
                 root_path: this.root_path.as_slice(),
                 title: title.as_slice(),
             };
@@ -1120,8 +1125,21 @@ impl Context {
                 title.push_str(it.name.get_ref().as_slice());
             }
             title.push_str(" - Rust");
+            let tyname = shortty(it).to_static_str();
+            let is_crate = match it.inner {
+                clean::ModuleItem(clean::Module { items: _, is_crate: true }) => true,
+                _ => false
+            };
+            let desc = if is_crate {
+                format!("API documentation for the Rust `{}` crate.",
+                        cx.layout.krate)
+            } else {
+                format!("API documentation for the Rust `{}` {} in crate `{}`.",
+                        it.name.get_ref(), tyname, cx.layout.krate)
+            };
             let page = layout::Page {
-                ty: shortty(it).to_static_str(),
+                ty: tyname,
+                description: desc.as_slice(),
                 root_path: cx.root_path.as_slice(),
                 title: title.as_slice(),
             };