added doc in source code, regenerated readme

IonicaBizau · Oct 7, 2015 · c30e271 · c30e271
1 parent 0758aee
commit c30e271
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -138,8 +138,8 @@ Runs COBOL code from Node.JS side.
 - **Function|String|Path** `input`: A function containing a comment with inline COBOL code, the cobol code itself or a path to a COBOL file.
 - **Object** `options`: An object containing the following fields:
  - `cwd` (String): Where the COBOL code will run (by default in the current working directory)
- - `free` (Boolean): Use free option while compiling with GnuCobol
  - `args` (Array): An array of strings to pass to the COBOL process.
+ - `free` (Boolean): Use free option while compiling with GnuCobol
  - `stdin` (Stream): An optional stdin stream used to pipe data to the stdin stream of the COBOL process.
  - `stderr` (Stream): An optional stderr stream used to pipe data to the stdin stream of the COBOL process.
  - `stdeout` (Stream): An optional stdout stream used to pipe data to the stdin stream of the COBOL process.

diff --git a/lib/index.js b/lib/index.js
@@ -21,6 +21,7 @@ var Spawn = require("child_process").spawn
  *
  *  - `cwd` (String): Where the COBOL code will run (by default in the current working directory)
  *  - `args` (Array): An array of strings to pass to the COBOL process.
+ *  - `free` (Boolean): Use free option while compiling with GnuCobol
  *  - `stdin` (Stream): An optional stdin stream used to pipe data to the stdin stream of the COBOL process.
  *  - `stderr` (Stream): An optional stderr stream used to pipe data to the stdin stream of the COBOL process.
  *  - `stdeout` (Stream): An optional stdout stream used to pipe data to the stdin stream of the COBOL process.