sample dox output

api.md

Component#toString()

• Generates string representation of this object
  • @returns Combination displayName and instanceCount

eventProxy()

• Creates a proxy of the inner method 'handlerProxy' with the 'topic', 'widget' and handler parameters set
  • @param topic event topic
  • @param widget target widget
  • @param handler target handler
  • @returns {Function} proxied handler

renderProxy()

• Creates a proxy of the inner method 'render' with the '$fn' parameter set
  • @param $fn jQuery method
  • @returns {Function} proxied render

render()

• Renders contents into element * @param contents (Function | String) Template/String to render * @param data (Object) If contents is a template - template data (optional) * @param deferred (Deferred) Deferred (optional) * @returns self

Topic#toString()

• Generates string representation of this object
  • @returns Instance topic

namespaceIterator()

• Namespace iterator
  • @param namespace (string) namespace
  • @param index (number) index

onAction()

• Action handler
  • @param $event (jQuery.Event) event

handler()

• Internal handler
  • • @param $event jQuery event

reverse()

• Internal comparator used for reverse sorting arrays

onResize()

• Internal onResize handler
  • @param $event

iterator()

• Iterator
  • @param index
  • @param self

interval()

• Internal interval

onDestroy()

• Generic destroy handler.
  • Simply makes sure that unweave has been called

compile()

• Compiles template
  • • @param body Template body
  • @returns {Function}