badmanners/maud
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

API comment conventions ()

Browse source
This commit is contained in:
Chris Wong 2015-03-06 12:50:14 +13:00
parent 74475f922b
commit a118f54612
1 changed files with 3 additions and 3 deletions

6
maud/src/lib.rs
View file

@ -158,7 +158,7 @@
use std::fmt; use std::fmt;
use std::io; use std::io;
/// Escape an HTML value. /// Escapes an HTML value.
pub fn escape(s: &str) -> String { pub fn escape(s: &str) -> String {
use std::fmt::Write; use std::fmt::Write;
let mut buf = String::new(); let mut buf = String::new();
@ -175,7 +175,7 @@ pub struct Markup<F> {
} }
impl<F> Markup<F> where F: Fn(&mut fmt::Write) -> fmt::Result { impl<F> Markup<F> where F: Fn(&mut fmt::Write) -> fmt::Result {
/// Render the markup to a `std::io::Write`. /// Renders the markup to a `std::io::Write`.
pub fn render<W: io::Write>(&self, w: &mut W) -> io::Result<()> { pub fn render<W: io::Write>(&self, w: &mut W) -> io::Result<()> {
struct Adaptor<'a, W: ?Sized + 'a> { struct Adaptor<'a, W: ?Sized + 'a> {
inner: &'a mut W, inner: &'a mut W,
@ -201,7 +201,7 @@ impl<F> Markup<F> where F: Fn(&mut fmt::Write) -> fmt::Result {
} }
} }
/// Render the markup to a `std::fmt::Write`. /// Renders the markup to a `std::fmt::Write`.
pub fn render_fmt(&self, w: &mut fmt::Write) -> fmt::Result { pub fn render_fmt(&self, w: &mut fmt::Write) -> fmt::Result {
(self.callback)(w) (self.callback)(w)
} }