note that comments must be removed from the JSON file (jsdoc/jsdoc#407)

Author: hegemonic

Jake/articles/about-configuring-jsdoc

@@ -58,7 +58,7 @@ A <a href="#example">full example</a> is provided at the end.
 
 <h2 name="configuration-file-files" id="configuration-file-files">Specifying input files</h2>
 
-<p>The "source" set of options, in combination with paths given to JSDoc on the command-line, determine what files JSDoc generates documentation for.</p>
+<p>The "source" set of options, in combination with paths given to JSDoc on the command-line, determine what files JSDoc generates documentation for. (Remove the comments before adding this example to your own .json file.)</p>
 
 {{#example}} 
     ...
@@ -156,6 +156,7 @@ To do this, use the longnames of the relevant options in an "opts" section of co
 
 {{#example}}opts
     ...
+    // You must remove the comments before adding these options to your .json file
     "opts": {
         "template": "default",            // same as -t default
         "encoding": "utf8",               // same as -e utf8
@@ -255,6 +256,7 @@ Example with all configuration options
 <p>Here is an example conf.json showing all possible configuration options native to the base JSDoc, along with their default values.</p>
 
 {{#example}}A conf.json showcasing all the configuration options to base JSDoc.
+    // You must remove the comments before adding these options to your .json file
     {
         "tags": {
             "allowUnknownTags": true

about-configuring-jsdoc.html

@@ -236,7 +236,7 @@ <h2 name="configuration-file" id="configuraton-file">Configuration File</h2>
 
 <h2 name="configuration-file-files" id="configuration-file-files">Specifying input files</h2>
 
-<p>The "source" set of options, in combination with paths given to JSDoc on the command-line, determine what files JSDoc generates documentation for.</p>
+<p>The "source" set of options, in combination with paths given to JSDoc on the command-line, determine what files JSDoc generates documentation for. (Remove the comments before adding this example to your own .json file.)</p>
 
 <dl class="example">
 <dt></dt>
@@ -353,6 +353,7 @@ <h2 name="configuration-file-command-line" id="configuration-file-command-line">
 <dd>
 <pre class="prettyprint lang-js">
 ...
+// You must remove the comments before adding these options to your .json file
 "opts": {
     "template": "default",            // same as -t default
     "encoding": "utf8",               // same as -e utf8
@@ -472,6 +473,7 @@ <h2 name="example" id="example">
 <dt>A conf.json showcasing all the configuration options to base JSDoc.</dt>
 <dd>
 <pre class="prettyprint lang-js">
+// You must remove the comments before adding these options to your .json file
 {
     "tags": {
         "allowUnknownTags": true