浏览代码

grunt-amberc: update inline documentation

Manfred Kroehnert 10 年之前
父节点
当前提交
2f712e25b2
共有 1 个文件被更改,包括 13 次插入3 次删除
  1. 13 3
      grunt/tasks/grunt-amberc.js

+ 13 - 3
grunt/tasks/grunt-amberc.js

@@ -5,9 +5,16 @@ module.exports = function(grunt) {
   var amberc = require('../../bin/amberc.js');
 
   /**
-     Full config looks like this:
+     A full example entry for a Gruntfile.js is available below.
+     Please note that the verbose level is either specified globally
+     or on a target specific level.
+     However, it can additionally be triggered on the commandline by
+     adding the '-v' or '--verbose' flag.
+
+     Example Gruntfile.js entry:
+
      amberc: {
-       _config: {
+       options: {
          amber_dir: process.cwd(),     // REQUIRED
          verbose: true                 // optional
        },
@@ -21,7 +28,10 @@ module.exports = function(grunt) {
          amd_namespace: 'MyNamespace',          // optional (default: 'amber')
          main_file: 'myMain.js',                // optional
          output_suffix: 'mySuffix',             // optional
-         library_suffix: '-0.9'                 // optional
+         library_suffix: '-0.9',                 // optional
+         options: {
+           verbose: true
+         }
        },
      },