Skip to content

Commit

Permalink
JSDoc improvements for stamps.
Browse files Browse the repository at this point in the history
  • Loading branch information
koresar committed Jun 9, 2015
1 parent 30acfa3 commit 8dabdef
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions stampit.js
Expand Up @@ -103,15 +103,15 @@ function compose(factories) {
* @param {Object} [options.init] A closure (function) used to create private data and privileged methods.
* @param {Object} [options.props] An object to be deeply cloned into each newly stamped object.
* @param {Object} [options.static] An object to be mixed into each `this` and derived stamps (not objects!).
* @return {Function} factory A factory to produce objectss.
* @return {Function} factory.create Just like calling the factory function.
* @return {Function(refs)} factory A factory to produce objects.
* @return {Function(refs)} factory.create Just like calling the factory function.
* @return {Object} factory.fixed An object map containing the stamp components.
* @return {Function} factory.methods Add methods to the stamp. Chainable.
* @return {Function} factory.refs Add references to the stamp. Chainable.
* @return {Function} factory.init Add a closure which called on object instantiation. Chainable.
* @return {Function} factory.props Add deeply cloned properties to the produced objects. Chainable.
* @return {Function} factory.compose Combine several stamps into single. Chainable.
* @return {Function} factory.static Add properties to the stamp (not objects!). Chainable.
* @return {Function(methods)} factory.methods Add methods to the stamp. Chainable.
* @return {Function(refs)} factory.refs Add references to the stamp. Chainable.
* @return {Function(Function(context))} factory.init Add a closure which called on object instantiation. Chainable.
* @return {Function(props)} factory.props Add deeply cloned properties to the produced objects. Chainable.
* @return {Function(stamps)} factory.compose Combine several stamps into single. Chainable.
* @return {Function(statics)} factory.static Add properties to the stamp (not objects!). Chainable.
*/
stampit = function stampit(options) {
var fixed = {methods: {}, refs: {}, init: [], props: {}, static: {}};
Expand Down

0 comments on commit 8dabdef

Please sign in to comment.