Skip to content

Commit

Permalink
Document mem-fs-editor in API doc, also remove references to src/dest…
Browse files Browse the repository at this point in the history
… object

Fix #727
  • Loading branch information
SBoudrias committed Dec 21, 2014
1 parent e8eaec7 commit f3e0f7a
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions lib/base.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,20 @@ var fileLogger = { write: _.noop, warn: _.noop };
* @param {String|Array} args
* @param {Object} options
*
* @property {Object} env - the current Environment being run
* @property {Object} args - Provide arguments at initialization
* @property {String} resolved - the path to the current generator
* @property {String} description - Used in `--help` output
* @property {String} appname - The application name
* @property {Storage} config - `.yo-rc` config file manager
* @property {Object} src - File util instance scoped to `sourceRoot`
* @property {Object} dest - File util instance scoped to `destinationRoot`
* @property {Function} log - Output content through Interface Adapter
* @property {Object} env - the current Environment being run
* @property {Object} args - Provide arguments at initialization
* @property {String} resolved - the path to the current generator
* @property {String} description - Used in `--help` output
* @property {String} appname - The application name
* @property {Storage} config - `.yo-rc` config file manager
* @property {Object} fs - An instance of {@link https://github.com/SBoudrias/mem-fs-editor Mem-fs-editor}
* @property {Function} log - Output content through Interface Adapter
*
* @example
* var yeoman = require('yeoman-generator');
* var MyGenerator = yeoman.generators.Base.extend({
* createGruntfile: function() {
* this.dest.write('// Grunt file content', 'Gruntfile.js');
* var generator = require('yeoman-generator');
* var MyGenerator = generator.Base.extend({
* writing: function() {
* this.fs.write('var foo = 1;', this.destinationPath('index.js'));
* }
* });
*/
Expand Down

0 comments on commit f3e0f7a

Please sign in to comment.