Add documentation here and there

johncf · johncf · commit 8ce68115c986 · 2016-04-02T12:53:25.000+05:30
diff --git a/src/clean/mod.rs b/src/clean/mod.rs
@@ -70,6 +70,12 @@ fn get_deprecation(cx: &DocContext, def_id: DefId) -> Option<Deprecation> {
     cx.tcx_opt().and_then(|tcx| stability::lookup_deprecation(tcx, def_id)).clean(cx)
 }
 
+/// Used to create "cleaned-up" doc-specific objects from ast and hir objects
+///
+/// The most important implementor is `visit_ast::RustdocVisitor` whose clean
+/// method is called only once during a rustdoc execution, which will then parse
+/// all source files and generate a humungus `Crate` object which will contain
+/// EVERYTHING!!
 pub trait Clean<T> {
     fn clean(&self, cx: &DocContext) -> T;
 }
diff --git a/src/externalfiles.rs b/src/externalfiles.rs
@@ -15,13 +15,18 @@ use std::path::{PathBuf, Path};
 use std::str;
 
 #[derive(Clone)]
+/// Representation of an external template
 pub struct ExternalHtml{
+    /// text to include in <head> section
     pub in_header: String,
+    /// text to include before the generated docs
     pub before_content: String,
+    /// text to include after the generated docs
     pub after_content: String
 }
 
 impl ExternalHtml {
+    /// The arguments are lists of paths; their contents are read into the respective fields
     pub fn load(in_header: &[String], before_content: &[String], after_content: &[String])
             -> Option<ExternalHtml> {
         match (load_external_files(in_header),

Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,12 @@ fn get_deprecation(cx: &DocContext, def_id: DefId) -> Option<Deprecation> {`
`70`	`70`	`cx.tcx_opt().and_then(\|tcx\| stability::lookup_deprecation(tcx, def_id)).clean(cx)`
`71`	`71`	`}`
`72`	`72`
	`73`	`+/// Used to create "cleaned-up" doc-specific objects from ast and hir objects`
	`74`	`+///`
	`75`	+/// The most important implementor is `visit_ast::RustdocVisitor` whose clean
	`76`	`+/// method is called only once during a rustdoc execution, which will then parse`
	`77`	+/// all source files and generate a humungus `Crate` object which will contain
	`78`	`+/// EVERYTHING!!`
`73`	`79`	`pub trait Clean<T> {`
`74`	`80`	`fn clean(&self, cx: &DocContext) -> T;`
`75`	`81`	`}`