bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

rustdoc: Document what's going on throughout

Browse source 
This addresses some of @huonw's in #9691 about the startling lack of
documentation guiding one throughout the innards of rustdoc::html
This commit is contained in:
Alex Crichton 2013-10-03 10:24:40 -07:00
parent ff30566954
commit cdb7701434
4 changed files with 188 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/librustdoc/html/escape.rs
View file

@ -8,8 +8,15 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! HTML Escaping
//!
//! This module contains one unit-struct which can be used to HTML-escape a
//! string of text (for use in a format string).
use std::fmt;
/// Wrapper struct which will emit the HTML-escaped version of the contained
/// string when passed to a format string.
pub struct Escape<'self>(&'self str);
impl<'self> fmt::Default for Escape<'self> {