Skip to content
Browse files

[doc] Update method documentation

  • Loading branch information...
1 parent 19db974 commit 6b96643dcf59a5355d5c4bfbe5c9c7a7a84329c9 @indexzero indexzero committed Feb 12, 2012
Showing with 17 additions and 0 deletions.
  1. +17 −0 lib/flatiron-cli-config.js
View
17 lib/flatiron-cli-config.js
@@ -9,9 +9,17 @@ var utile = require('flatiron').common;
var cliConfig = exports;
+//
+// Expose commands and name this plugin
+//
cliConfig.commands = require('./commands');
cliConfig.name = 'cli-config';
+//
+// ### function attach (options)
+// #### @options {Object} Options to use when attaching
+// Attaches the `flatiron-cli-config` behavior to the application.
+//
cliConfig.attach = function (options) {
var app = this;
options = options || {};
@@ -35,6 +43,10 @@ cliConfig.attach = function (options) {
app.alias('conf', { resource: 'config', command: 'list' });
};
+//
+// ### function detach ()
+// Detaches this plugin from the application.
+//
cliConfig.detach = function () {
var app = this;
@@ -47,6 +59,11 @@ cliConfig.detach = function () {
});
};
+//
+// ### function setUsage ()
+// Updates the command usage for the `<app>` this instance
+// is attached to.
+//
cliConfig.setUsage = function () {
if (!cliConfig.app.name) {
return;

0 comments on commit 6b96643

Please sign in to comment.
Something went wrong with that request. Please try again.