about summary refs log tree commit diff
path: root/src/librustdoc/formats/renderer.rs
diff options
context:
space:
mode:
authorJoseph Ryan <josephryan3.14@gmail.com>2020-06-26 08:18:20 -0500
committerJoseph Ryan <josephryan3.14@gmail.com>2020-07-27 16:00:38 -0500
commita7909522547cb35b32a4f11b78b2b54864189295 (patch)
treed1dbc926a8d5f380d70914008fb53b3395e3e9dd /src/librustdoc/formats/renderer.rs
parent6a4396b98c6fcb405429a9798a9ab6554f015b7e (diff)
downloadrust-a7909522547cb35b32a4f11b78b2b54864189295.tar.gz
rust-a7909522547cb35b32a4f11b78b2b54864189295.zip
Pull out more types from html
Diffstat (limited to 'src/librustdoc/formats/renderer.rs')
-rw-r--r--src/librustdoc/formats/renderer.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/librustdoc/formats/renderer.rs b/src/librustdoc/formats/renderer.rs
index f1862337ba1..d4ba6726cd2 100644
--- a/src/librustdoc/formats/renderer.rs
+++ b/src/librustdoc/formats/renderer.rs
@@ -10,6 +10,8 @@ use crate::formats::cache::{Cache, CACHE_KEY};
 pub trait FormatRenderer: Clone {
     type Output: FormatRenderer;
 
+    /// Sets up any state required for the emulator. When this is called the cache has already been
+    /// populated.
     fn init(
         krate: clean::Crate,
         options: RenderOptions,
@@ -30,7 +32,7 @@ pub trait FormatRenderer: Clone {
     ) -> Result<(), Error>;
 
     /// Runs after recursively rendering all sub-items of a module.
-    fn mod_item_out(&mut self, name: &str) -> Result<(), Error>;
+    fn mod_item_out(&mut self, item_name: &str) -> Result<(), Error>;
 
     /// Post processing hook for cleanup and dumping output to files.
     fn after_krate(&mut self, krate: &clean::Crate, cache: &Cache) -> Result<(), Error>;