Skip to content

Commit

Permalink
Document (JSDoc) the static stuff of stampit and factories.
Browse files Browse the repository at this point in the history
  • Loading branch information
koresar committed Jun 1, 2015
1 parent 8b232dc commit 7a3a118
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions stampit.js
Expand Up @@ -103,13 +103,15 @@ function compose(factories) {
* @param {Object} [options.refs] A map of property names and values to be mixed into each new object.
* @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 {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.static Add properties to the stamp (not objects!). Chainable.
* @return {Function} factory.compose Combine several stamps into single. Chainable.
*/
stampit = function stampit(options) {
Expand Down

0 comments on commit 7a3a118

Please sign in to comment.