Document polyglot mode

Author: tmcw

README.md

@@ -14,6 +14,8 @@ $ npm install --save-dev gulp-documentation
 
 ## API
 
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
 ### documentation
 
 Documentation stream intended for use within the gulp system.
@@ -74,6 +76,18 @@ gulp.task('documentation-html-options', function () {
     }))
     .pipe(gulp.dest('html-documentation'));
 
+});
+
+// Document non-JavaScript files with JSDoc comments using polyglot: true
+gulp.task('documentation-for-cplusplus', function () {
+
+  gulp.src('./src/*.cpp')
+    .pipe(gulpDocumentation('html', { polyglot: true }, {
+      name: 'My Project',
+      version: '1.0.0'
+    }))
+    .pipe(gulp.dest('html-documentation'));
+
 });
 ```
 

index.js

@@ -59,6 +59,18 @@ var File = require('vinyl');
  *     .pipe(gulp.dest('html-documentation'));
  * 
  * });
+ *
+ * // Document non-JavaScript files with JSDoc comments using polyglot: true
+ * gulp.task('documentation-for-cplusplus', function () {
+ * 
+ *   gulp.src('./src/*.cpp')
+ *     .pipe(gulpDocumentation('html', { polyglot: true }, {
+ *       name: 'My Project',
+ *       version: '1.0.0'
+ *     }))
+ *     .pipe(gulp.dest('html-documentation'));
+ * 
+ * });
  */
 module.exports = function (format, options, formatterOptions) {
   var files = [];

package.json

@@ -4,7 +4,7 @@
   "version": "2.2.0",
   "author": "Tom MacWright",
   "dependencies": {
-    "documentation": "^4.0.0-beta12",
+    "documentation": "4.0.0-beta13",
     "through2": "^2.0.1",
     "vinyl": "^2.0.0"
   },

test-manual/multi/gulpfile.js

@@ -9,6 +9,14 @@ gulp.task('documentation', function () {
 
 });
 
+gulp.task('documentation-polyglot', function () {
+
+  gulp.src('./src-cpp/*.js')
+    .pipe(gulpDocumentation('md', { polyglot: true }))
+    .pipe(gulp.dest('cpp-documentation'));
+
+});
+
 gulp.task('documentation-shallow', function () {
 
   gulp.src('./src/*.js')