Skip to content

Commit

Permalink
adding renderer for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
justinbmeyer committed Jun 16, 2013
1 parent 41c3839 commit 9d63767
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions view/mustache/doc/renderer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
@typedef {function(Object,Object.<String, function>):documentFragment} can.view.renderer(data,helpers) renderer

@description A function returned by [can.view], [can.view.ejs], [can.view.mustache] that renders a
template into an html documentFragment.

@param {Object} data An object of data used to render the template.

@param {Object.<String, function>} helpers Local helper functions used by the template.

@return {documentFragment} A documentFragment that contains the HTML rendered by the template.

@body

A "renderer" function is a function returned by various [can.view] APIs that can be used
to render data into a documentFragment.

0 comments on commit 9d63767

Please sign in to comment.