Added sections option to split TOC into sections.

README.md

@@ -35,6 +35,10 @@ Use the `apidox` property in your Grunt config. You can supply the following opt
 
 - `inputTitle` (optional, string |`false`): By default, `apidox` includes a line in the markdown saying it was generated from the `input` file. Set `inputTitle` to `false` to prevent this, or set it to a string to change the text.
 
+- `fullSourceDescription` (optional, boolean): By default, `apidox` includes only the first sentence of the first comment in the output. Set `fullSourceDescription` to `true` to include all of the first comment in the output.
+
+- `sections` (optional, object): Use this to divide the table of contents into sections. Each key in `sections` is the name of the first function in a section. The value is the markdown to insert before the link to the function in the table of contents.
+
 ## More Examples
 
 Write to a subdirectory:
@@ -91,6 +95,18 @@ apidox: {
 }
 ```
 
+Split the table of contents into two sections, `foo` and `bar`:
+
+```javascript
+apidox: {
+    input: 'index.js',
+    sections: {
+        someFunction: '##foo',
+        someOtherFunction: '##bar'
+    }
+}
+```
+
 ## Licence
 
 [MIT](LICENCE)

coverage/coverage.json

@@ -1 +1 @@
-{"/home/david/Private/hub/common/grunt-apidox/Gruntfile.js":{"path":"/home/david/Private/hub/common/grunt-apidox/Gruntfile.js","s":{"1":1,"2":1,"3":1,"4":1,"5":1,"6":1,"7":1,"8":1,"9":1,"10":1,"11":1,"12":1,"13":1},"b":{},"f":{"1":1},"fnMap":{"1":{"name":"(anonymous_1)","line":4,"loc":{"start":{"line":4,"column":17},"end":{"line":5,"column":0}}}},"statementMap":{"1":{"start":{"line":2,"column":0},"end":{"line":2,"column":13}},"2":{"start":{"line":4,"column":0},"end":{"line":52,"column":2}},"3":{"start":{"line":6,"column":4},"end":{"line":39,"column":7}},"4":{"start":{"line":41,"column":4},"end":{"line":41,"column":39}},"5":{"start":{"line":42,"column":4},"end":{"line":42,"column":43}},"6":{"start":{"line":43,"column":4},"end":{"line":43,"column":37}},"7":{"start":{"line":44,"column":4},"end":{"line":44,"column":29}},"8":{"start":{"line":46,"column":4},"end":{"line":46,"column":41}},"9":{"start":{"line":47,"column":4},"end":{"line":47,"column":44}},"10":{"start":{"line":48,"column":4},"end":{"line":48,"column":41}},"11":{"start":{"line":49,"column":4},"end":{"line":49,"column":71}},"12":{"start":{"line":50,"column":4},"end":{"line":50,"column":54}},"13":{"start":{"line":51,"column":4},"end":{"line":51,"column":59}}},"branchMap":{}},"/home/david/Private/hub/common/grunt-apidox/tasks/apidox.js":{"path":"/home/david/Private/hub/common/grunt-apidox/tasks/apidox.js","s":{"1":1,"2":1,"3":1,"4":1,"5":17,"6":17,"7":41,"8":17,"9":17,"10":17,"11":17,"12":1,"13":2,"14":4,"15":1,"16":17,"17":17,"18":17,"19":2,"20":17,"21":17,"22":17,"23":2,"24":2,"25":2,"26":2,"27":15,"28":15,"29":15,"30":15,"31":17,"32":17,"33":16,"34":16,"35":9,"36":8,"37":6,"38":2,"39":2,"40":2,"41":1,"42":8,"43":8,"44":7,"45":9,"46":9,"47":9},"b":{"1":[2,15],"2":[17,16],"3":[2,15],"4":[17,7],"5":[16,1],"6":[9,7],"7":[8,1],"8":[6,2],"9":[1,1]},"f":{"1":1,"2":17,"3":2,"4":4,"5":17},"fnMap":{"1":{"name":"(anonymous_1)","line":119,"loc":{"start":{"line":119,"column":17},"end":{"line":120,"column":0}}},"2":{"name":"convert","line":121,"loc":{"start":{"line":121,"column":4},"end":{"line":122,"column":4}}},"3":{"name":"readFiles","line":139,"loc":{"start":{"line":139,"column":4},"end":{"line":140,"column":4}}},"4":{"name":"(anonymous_4)","line":141,"loc":{"start":{"line":141,"column":25},"end":{"line":142,"column":8}}},"5":{"name":"(anonymous_5)","line":148,"loc":{"start":{"line":148,"column":4},"end":{"line":149,"column":4}}}},"statementMap":{"1":{"start":{"line":114,"column":0},"end":{"line":114,"column":13}},"2":{"start":{"line":116,"column":0},"end":{"line":117,"column":31}},"3":{"start":{"line":119,"column":0},"end":{"line":227,"column":2}},"4":{"start":{"line":121,"column":4},"end":{"line":137,"column":5}},"5":{"start":{"line":123,"column":8},"end":{"line":123,"column":39}},"6":{"start":{"line":126,"column":8},"end":{"line":129,"column":9}},"7":{"start":{"line":128,"column":12},"end":{"line":128,"column":39}},"8":{"start":{"line":132,"column":8},"end":{"line":132,"column":32}},"9":{"start":{"line":133,"column":8},"end":{"line":133,"column":34}},"10":{"start":{"line":134,"column":8},"end":{"line":134,"column":20}},"11":{"start":{"line":136,"column":8},"end":{"line":136,"column":48}},"12":{"start":{"line":139,"column":4},"end":{"line":145,"column":5}},"13":{"start":{"line":141,"column":8},"end":{"line":144,"column":20}},"14":{"start":{"line":143,"column":12},"end":{"line":143,"column":38}},"15":{"start":{"line":147,"column":4},"end":{"line":226,"column":7}},"16":{"start":{"line":150,"column":8},"end":{"line":150,"column":40}},"17":{"start":{"line":152,"column":8},"end":{"line":153,"column":52}},"18":{"start":{"line":155,"column":8},"end":{"line":159,"column":9}},"19":{"start":{"line":158,"column":12},"end":{"line":158,"column":30}},"20":{"start":{"line":161,"column":8},"end":{"line":225,"column":9}},"21":{"start":{"line":163,"column":12},"end":{"line":163,"column":28}},"22":{"start":{"line":165,"column":12},"end":{"line":178,"column":13}},"23":{"start":{"line":167,"column":16},"end":{"line":167,"column":28}},"24":{"start":{"line":168,"column":16},"end":{"line":168,"column":30}},"25":{"start":{"line":169,"column":16},"end":{"line":169,"column":30}},"26":{"start":{"line":170,"column":16},"end":{"line":170,"column":25}},"27":{"start":{"line":174,"column":16},"end":{"line":174,"column":41}},"28":{"start":{"line":175,"column":16},"end":{"line":175,"column":34}},"29":{"start":{"line":176,"column":16},"end":{"line":176,"column":36}},"30":{"start":{"line":177,"column":16},"end":{"line":177,"column":36}},"31":{"start":{"line":180,"column":12},"end":{"line":180,"column":50}},"32":{"start":{"line":182,"column":12},"end":{"line":224,"column":13}},"33":{"start":{"line":184,"column":16},"end":{"line":184,"column":49}},"34":{"start":{"line":186,"column":16},"end":{"line":223,"column":17}},"35":{"start":{"line":188,"column":20},"end":{"line":207,"column":21}},"36":{"start":{"line":190,"column":24},"end":{"line":203,"column":25}},"37":{"start":{"line":192,"column":28},"end":{"line":192,"column":45}},"38":{"start":{"line":196,"column":28},"end":{"line":196,"column":46}},"39":{"start":{"line":197,"column":28},"end":{"line":197,"column":61}},"40":{"start":{"line":199,"column":28},"end":{"line":202,"column":29}},"41":{"start":{"line":201,"column":32},"end":{"line":201,"column":55}},"42":{"start":{"line":205,"column":24},"end":{"line":205,"column":62}},"43":{"start":{"line":206,"column":24},"end":{"line":206,"column":52}},"44":{"start":{"line":211,"column":20},"end":{"line":222,"column":21}},"45":{"start":{"line":213,"column":24},"end":{"line":213,"column":41}},"46":{"start":{"line":214,"column":24},"end":{"line":220,"column":67}},"47":{"start":{"line":221,"column":24},"end":{"line":221,"column":52}}},"branchMap":{"1":{"line":155,"type":"if","locations":[{"start":{"line":155,"column":8},"end":{"line":155,"column":8}},{"start":{"line":155,"column":8},"end":{"line":155,"column":8}}]},"2":{"line":155,"type":"binary-expr","locations":[{"start":{"line":155,"column":13},"end":{"line":155,"column":39}},{"start":{"line":156,"column":13},"end":{"line":156,"column":40}}]},"3":{"line":165,"type":"if","locations":[{"start":{"line":165,"column":12},"end":{"line":165,"column":12}},{"start":{"line":165,"column":12},"end":{"line":165,"column":12}}]},"4":{"line":180,"type":"binary-expr","locations":[{"start":{"line":180,"column":36},"end":{"line":180,"column":42}},{"start":{"line":180,"column":46},"end":{"line":180,"column":48}}]},"5":{"line":182,"type":"if","locations":[{"start":{"line":182,"column":12},"end":{"line":182,"column":12}},{"start":{"line":182,"column":12},"end":{"line":182,"column":12}}]},"6":{"line":186,"type":"if","locations":[{"start":{"line":186,"column":16},"end":{"line":186,"column":16}},{"start":{"line":186,"column":16},"end":{"line":186,"column":16}}]},"7":{"line":188,"type":"if","locations":[{"start":{"line":188,"column":20},"end":{"line":188,"column":20}},{"start":{"line":188,"column":20},"end":{"line":188,"column":20}}]},"8":{"line":190,"type":"if","locations":[{"start":{"line":190,"column":24},"end":{"line":190,"column":24}},{"start":{"line":190,"column":24},"end":{"line":190,"column":24}}]},"9":{"line":199,"type":"if","locations":[{"start":{"line":199,"column":28},"end":{"line":199,"column":28}},{"start":{"line":199,"column":28},"end":{"line":199,"column":28}}]}}}}
+{"/tmp/grunt-apidox/Gruntfile.js":{"path":"/tmp/grunt-apidox/Gruntfile.js","s":{"1":1,"2":1,"3":1,"4":1,"5":1,"6":1,"7":1,"8":1,"9":1,"10":1,"11":1,"12":1,"13":1},"b":{},"f":{"1":1},"fnMap":{"1":{"name":"(anonymous_1)","line":4,"loc":{"start":{"line":4,"column":17},"end":{"line":5,"column":0}}}},"statementMap":{"1":{"start":{"line":2,"column":0},"end":{"line":2,"column":13}},"2":{"start":{"line":4,"column":0},"end":{"line":52,"column":2}},"3":{"start":{"line":6,"column":4},"end":{"line":39,"column":7}},"4":{"start":{"line":41,"column":4},"end":{"line":41,"column":39}},"5":{"start":{"line":42,"column":4},"end":{"line":42,"column":43}},"6":{"start":{"line":43,"column":4},"end":{"line":43,"column":37}},"7":{"start":{"line":44,"column":4},"end":{"line":44,"column":29}},"8":{"start":{"line":46,"column":4},"end":{"line":46,"column":41}},"9":{"start":{"line":47,"column":4},"end":{"line":47,"column":44}},"10":{"start":{"line":48,"column":4},"end":{"line":48,"column":41}},"11":{"start":{"line":49,"column":4},"end":{"line":49,"column":71}},"12":{"start":{"line":50,"column":4},"end":{"line":50,"column":54}},"13":{"start":{"line":51,"column":4},"end":{"line":51,"column":59}}},"branchMap":{}},"/tmp/grunt-apidox/tasks/apidox.js":{"path":"/tmp/grunt-apidox/tasks/apidox.js","s":{"1":1,"2":1,"3":1,"4":1,"5":18,"6":18,"7":43,"8":18,"9":18,"10":18,"11":18,"12":18,"13":1,"14":2,"15":2,"16":18,"17":1,"18":2,"19":4,"20":1,"21":18,"22":18,"23":18,"24":3,"25":18,"26":18,"27":18,"28":2,"29":2,"30":2,"31":2,"32":16,"33":16,"34":16,"35":16,"36":18,"37":18,"38":17,"39":17,"40":9,"41":8,"42":6,"43":2,"44":2,"45":2,"46":1,"47":8,"48":8,"49":8,"50":10,"51":10,"52":10},"b":{"1":[1,17],"2":[3,15],"3":[18,17],"4":[2,16],"5":[18,8],"6":[17,1],"7":[9,8],"8":[8,1],"9":[6,2],"10":[1,1]},"f":{"1":1,"2":18,"3":2,"4":4,"5":18},"fnMap":{"1":{"name":"(anonymous_1)","line":144,"loc":{"start":{"line":144,"column":17},"end":{"line":145,"column":0}}},"2":{"name":"convert","line":146,"loc":{"start":{"line":146,"column":4},"end":{"line":147,"column":4}}},"3":{"name":"readFiles","line":177,"loc":{"start":{"line":177,"column":4},"end":{"line":178,"column":4}}},"4":{"name":"(anonymous_4)","line":179,"loc":{"start":{"line":179,"column":25},"end":{"line":180,"column":8}}},"5":{"name":"(anonymous_5)","line":186,"loc":{"start":{"line":186,"column":4},"end":{"line":187,"column":4}}}},"statementMap":{"1":{"start":{"line":139,"column":0},"end":{"line":139,"column":13}},"2":{"start":{"line":141,"column":0},"end":{"line":142,"column":31}},"3":{"start":{"line":144,"column":0},"end":{"line":265,"column":2}},"4":{"start":{"line":146,"column":4},"end":{"line":175,"column":5}},"5":{"start":{"line":148,"column":8},"end":{"line":148,"column":57}},"6":{"start":{"line":151,"column":8},"end":{"line":154,"column":9}},"7":{"start":{"line":153,"column":12},"end":{"line":153,"column":39}},"8":{"start":{"line":157,"column":8},"end":{"line":157,"column":32}},"9":{"start":{"line":158,"column":8},"end":{"line":158,"column":34}},"10":{"start":{"line":159,"column":8},"end":{"line":159,"column":20}},"11":{"start":{"line":161,"column":8},"end":{"line":161,"column":28}},"12":{"start":{"line":163,"column":8},"end":{"line":172,"column":9}},"13":{"start":{"line":166,"column":12},"end":{"line":170,"column":13}},"14":{"start":{"line":168,"column":16},"end":{"line":168,"column":121}},"15":{"start":{"line":169,"column":16},"end":{"line":169,"column":74}},"16":{"start":{"line":174,"column":8},"end":{"line":174,"column":38}},"17":{"start":{"line":177,"column":4},"end":{"line":183,"column":5}},"18":{"start":{"line":179,"column":8},"end":{"line":182,"column":20}},"19":{"start":{"line":181,"column":12},"end":{"line":181,"column":38}},"20":{"start":{"line":185,"column":4},"end":{"line":264,"column":7}},"21":{"start":{"line":188,"column":8},"end":{"line":188,"column":40}},"22":{"start":{"line":190,"column":8},"end":{"line":191,"column":52}},"23":{"start":{"line":193,"column":8},"end":{"line":197,"column":9}},"24":{"start":{"line":196,"column":12},"end":{"line":196,"column":30}},"25":{"start":{"line":199,"column":8},"end":{"line":263,"column":9}},"26":{"start":{"line":201,"column":12},"end":{"line":201,"column":28}},"27":{"start":{"line":203,"column":12},"end":{"line":216,"column":13}},"28":{"start":{"line":205,"column":16},"end":{"line":205,"column":28}},"29":{"start":{"line":206,"column":16},"end":{"line":206,"column":30}},"30":{"start":{"line":207,"column":16},"end":{"line":207,"column":30}},"31":{"start":{"line":208,"column":16},"end":{"line":208,"column":25}},"32":{"start":{"line":212,"column":16},"end":{"line":212,"column":41}},"33":{"start":{"line":213,"column":16},"end":{"line":213,"column":34}},"34":{"start":{"line":214,"column":16},"end":{"line":214,"column":36}},"35":{"start":{"line":215,"column":16},"end":{"line":215,"column":36}},"36":{"start":{"line":218,"column":12},"end":{"line":218,"column":50}},"37":{"start":{"line":220,"column":12},"end":{"line":262,"column":13}},"38":{"start":{"line":222,"column":16},"end":{"line":222,"column":49}},"39":{"start":{"line":224,"column":16},"end":{"line":261,"column":17}},"40":{"start":{"line":226,"column":20},"end":{"line":245,"column":21}},"41":{"start":{"line":228,"column":24},"end":{"line":241,"column":25}},"42":{"start":{"line":230,"column":28},"end":{"line":230,"column":45}},"43":{"start":{"line":234,"column":28},"end":{"line":234,"column":46}},"44":{"start":{"line":235,"column":28},"end":{"line":235,"column":61}},"45":{"start":{"line":237,"column":28},"end":{"line":240,"column":29}},"46":{"start":{"line":239,"column":32},"end":{"line":239,"column":55}},"47":{"start":{"line":243,"column":24},"end":{"line":243,"column":62}},"48":{"start":{"line":244,"column":24},"end":{"line":244,"column":52}},"49":{"start":{"line":249,"column":20},"end":{"line":260,"column":21}},"50":{"start":{"line":251,"column":24},"end":{"line":251,"column":41}},"51":{"start":{"line":252,"column":24},"end":{"line":258,"column":67}},"52":{"start":{"line":259,"column":24},"end":{"line":259,"column":52}}},"branchMap":{"1":{"line":163,"type":"if","locations":[{"start":{"line":163,"column":8},"end":{"line":163,"column":8}},{"start":{"line":163,"column":8},"end":{"line":163,"column":8}}]},"2":{"line":193,"type":"if","locations":[{"start":{"line":193,"column":8},"end":{"line":193,"column":8}},{"start":{"line":193,"column":8},"end":{"line":193,"column":8}}]},"3":{"line":193,"type":"binary-expr","locations":[{"start":{"line":193,"column":13},"end":{"line":193,"column":39}},{"start":{"line":194,"column":13},"end":{"line":194,"column":40}}]},"4":{"line":203,"type":"if","locations":[{"start":{"line":203,"column":12},"end":{"line":203,"column":12}},{"start":{"line":203,"column":12},"end":{"line":203,"column":12}}]},"5":{"line":218,"type":"binary-expr","locations":[{"start":{"line":218,"column":36},"end":{"line":218,"column":42}},{"start":{"line":218,"column":46},"end":{"line":218,"column":48}}]},"6":{"line":220,"type":"if","locations":[{"start":{"line":220,"column":12},"end":{"line":220,"column":12}},{"start":{"line":220,"column":12},"end":{"line":220,"column":12}}]},"7":{"line":224,"type":"if","locations":[{"start":{"line":224,"column":16},"end":{"line":224,"column":16}},{"start":{"line":224,"column":16},"end":{"line":224,"column":16}}]},"8":{"line":226,"type":"if","locations":[{"start":{"line":226,"column":20},"end":{"line":226,"column":20}},{"start":{"line":226,"column":20},"end":{"line":226,"column":20}}]},"9":{"line":228,"type":"if","locations":[{"start":{"line":228,"column":24},"end":{"line":228,"column":24}},{"start":{"line":228,"column":24},"end":{"line":228,"column":24}}]},"10":{"line":237,"type":"if","locations":[{"start":{"line":237,"column":28},"end":{"line":237,"column":28}},{"start":{"line":237,"column":28},"end":{"line":237,"column":28}}]}}}}

coverage/lcov-report/grunt-apidox/Gruntfile.js.html

@@ -360,7 +360,7 @@ <h2>
 
 </div>
 <div class="footer">
-    <div class="meta">Generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jun 26 2013 09:55:49 GMT+0100 (BST)</div>
+    <div class="meta">Generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Aug 14 2013 23:23:27 GMT+0100 (BST)</div>
 </div>
 
 <script src="../prettify.js"></script>

coverage/lcov-report/grunt-apidox/index.html

@@ -232,7 +232,7 @@ <h2>
 </div>
 </div>
 <div class="footer">
-    <div class="meta">Generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Jun 26 2013 09:55:49 GMT+0100 (BST)</div>
+    <div class="meta">Generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Aug 14 2013 23:23:27 GMT+0100 (BST)</div>
 </div>
 
 <script src="../prettify.js"></script>