Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

updated docs

  • Loading branch information...
commit f031d64460d7001fcb2662674bb7f9cf0d1bdb51 1 parent 97e30a3
Doug Martin authored

Showing 75 changed files with 23,008 additions and 2,301 deletions. Show diff stats Hide diff stats

  1. +162 160 README.html
  2. +39 38 README.md
  3. +5 2 bin/coddoc
  4. +808 0 docs/assets/css/bootstrap-responsive.css
  5. +4,960 0 docs/assets/css/bootstrap.css
  6. +841 0 docs/assets/css/docs.css
  7. BIN  docs/assets/ico/apple-touch-icon-114-precomposed.png
  8. BIN  docs/assets/ico/apple-touch-icon-144-precomposed.png
  9. BIN  docs/assets/ico/apple-touch-icon-57-precomposed.png
  10. BIN  docs/assets/ico/apple-touch-icon-72-precomposed.png
  11. BIN  docs/assets/ico/favicon.ico
  12. BIN  docs/assets/img/bird.png
  13. BIN  docs/assets/img/bootstrap-mdo-sfmoma-01.jpg
  14. BIN  docs/assets/img/bootstrap-mdo-sfmoma-02.jpg
  15. BIN  docs/assets/img/bootstrap-mdo-sfmoma-03.jpg
  16. BIN  docs/assets/img/browsers.png
  17. BIN  docs/assets/img/example-sites/fleetio.png
  18. BIN  docs/assets/img/example-sites/jshint.png
  19. BIN  docs/assets/img/example-sites/kippt.png
  20. BIN  docs/assets/img/example-sites/soundready.png
  21. BIN  docs/assets/img/examples/bootstrap-example-fluid.jpg
  22. BIN  docs/assets/img/examples/bootstrap-example-hero.jpg
  23. BIN  docs/assets/img/examples/bootstrap-example-starter.jpg
  24. BIN  docs/assets/img/github-16px.png
  25. BIN  docs/assets/img/glyphicons-halflings-white.png
  26. BIN  docs/assets/img/glyphicons-halflings.png
  27. BIN  docs/assets/img/glyphicons/glyphicons_009_magic.png
  28. BIN  docs/assets/img/glyphicons/glyphicons_042_group.png
  29. BIN  docs/assets/img/glyphicons/glyphicons_079_podium.png
  30. BIN  docs/assets/img/glyphicons/glyphicons_082_roundabout.png
  31. BIN  docs/assets/img/glyphicons/glyphicons_155_show_thumbnails.png
  32. BIN  docs/assets/img/glyphicons/glyphicons_163_iphone.png
  33. BIN  docs/assets/img/glyphicons/glyphicons_214_resize_small.png
  34. BIN  docs/assets/img/glyphicons/glyphicons_266_book_open.png
  35. BIN  docs/assets/img/grid-18px-masked.png
  36. BIN  docs/assets/img/icon-css3.png
  37. BIN  docs/assets/img/icon-github.png
  38. BIN  docs/assets/img/icon-html5.png
  39. BIN  docs/assets/img/icon-twitter.png
  40. BIN  docs/assets/img/less-logo-large.png
  41. BIN  docs/assets/img/less-small.png
  42. BIN  docs/assets/img/responsive-illustrations.png
  43. +106 0 docs/assets/js/README.md
  44. +184 0 docs/assets/js/application.js
  45. +90 0 docs/assets/js/bootstrap-alert.js
  46. +96 0 docs/assets/js/bootstrap-button.js
  47. +169 0 docs/assets/js/bootstrap-carousel.js
  48. +157 0 docs/assets/js/bootstrap-collapse.js
  49. +100 0 docs/assets/js/bootstrap-dropdown.js
  50. +218 0 docs/assets/js/bootstrap-modal.js
  51. +98 0 docs/assets/js/bootstrap-popover.js
  52. +151 0 docs/assets/js/bootstrap-scrollspy.js
  53. +135 0 docs/assets/js/bootstrap-tab.js
  54. +275 0 docs/assets/js/bootstrap-tooltip.js
  55. +61 0 docs/assets/js/bootstrap-transition.js
  56. +285 0 docs/assets/js/bootstrap-typeahead.js
  57. +1,824 0 docs/assets/js/bootstrap.js
  58. +6 0 docs/assets/js/bootstrap.min.js
  59. +30 0 docs/assets/js/google-code-prettify/prettify.css
  60. +28 0 docs/assets/js/google-code-prettify/prettify.js
  61. +9,252 0 docs/assets/js/jquery.js
  62. +886 0 docs/coddoc.html
  63. +726 0 docs/coddoc_Context.html
  64. +352 0 docs/coddoc_Symbol.html
  65. +812 0 docs/coddoc_Tree.html
  66. +104 2,074 docs/index.html
  67. +9 0 lib/index.js
  68. +1 1  templates/html/index.js
  69. +7 5 templates/html/top-nav.tmpl
  70. +1 1  templates/multi-html/footer.html
  71. +7 2 templates/multi-html/footer.tmpl
  72. +0 1  templates/multi-html/index.html
  73. +14 8 templates/multi-html/index.js
  74. +7 7 templates/multi-html/namespace-nav.tmpl
  75. +2 2 templates/multi-html/top-nav.tmpl
322 README.html
@@ -119,9 +119,9 @@
119 119 <span class="icon-bar"></span>
120 120 </a>
121 121
122   - <a href="#" class="brand">coddoc</a>
  122 + <a href="./index.html" class="brand">coddoc</a>
123 123
124   - <div class="nav-collapse">
  124 + <div class="nav-collapse">
125 125 <ul class="nav nav-pills">
126 126
127 127 <li class="dropdown">
@@ -148,6 +148,11 @@
148 148 </li>
149 149
150 150 </ul>
  151 +
  152 + <ul class="nav pull-right">
  153 + <li><a href="https://github.com/doug-martin/coddoc" target="#github" class="pull-right">github</a></li>
  154 + </ul>
  155 +
151 156 </div>
152 157 </div>
153 158 </div>
@@ -163,7 +168,7 @@
163 168 <h2> Description</h2>
164 169 <p>
165 170 coddoc is a jsdoc parsing library. Coddoc is different in that it is easily extensible by allowing users to
166   - add tag and code parsers through the use of <a href='#coddoc_addTagHandler'>coddoc.addTagHandler</a> and <a href='#coddoc_addCodeHandler'>coddoc.addCodeHandler</a>.
  171 + add tag and code parsers through the use of <a href='#coddoc_addTagHandler'> coddoc.addTagHandler</a> and <a href='#coddoc_addCodeHandler'> coddoc.addCodeHandler</a>.
167 172 coddoc also parses source code to be used in APIs.
168 173 </p>
169 174
@@ -205,7 +210,19 @@
205 210 Coddoc also has a few additional tags.
206 211 <ul>
207 212 <li>ignoreCode : ignore the parsed code in the output</li>
  213 + <li>includeDoc : include an external doc. External docs can be html or markdown.
  214 + Example <pre class='prettyprint linenums lang-js'>
  215 + &#64;includeDoc [Title Of Doc] ../location/of_doc.md
  216 +</pre>
  217 + </li>
208 218 <li>projectName : document the projectName</li>
  219 + <li>github : url to github project</li>
  220 + <li>code : specifies a code block without needing an <code>example</code> tag
  221 + Example <pre class='prettyprint linenums lang-js'>
  222 + &#123;&#64;code var test = "test"; &#125;
  223 +</pre>
  224 + </li>
  225 +
209 226 <li>header : allows you to document a header that should appear before
210 227 generated documentation</li>
211 228 <li>footer : allows you to document a footer that should come after the generated documentation</li>
@@ -215,12 +232,14 @@
215 232
216 233 <h2>Installation</h2>
217 234 Locally
218   -
219   -<pre>npm install coddoc</pre>
220   -
  235 +<pre class='prettyprint linenums lang-js'>
  236 + npm install coddoc
  237 +</pre>
221 238 Globally
222 239
223   -<pre>npm install -g coddoc</pre>
  240 +<pre class='prettyprint linenums lang-js'>
  241 + npm install -g coddoc
  242 +</pre>
224 243
225 244 <h2>Usage</h2>
226 245 Down doc does not currently create multi file docs instead will output to a single file. You may however implement
@@ -236,25 +255,31 @@
236 255 </ul>
237 256
238 257 Examples
239   -<pre>
240   -coddoc -d ./lib > symbols.json
  258 +
  259 +JSON output
  260 +<pre class='prettyprint linenums lang-js'>
  261 + coddoc -d ./lib > symbols.json
241 262 </pre>
242   -To use the markdown formmater
243   -<pre>
244   -coddoc -d ./lib -f markdown > README.md
  263 +
  264 +To use the markdown formatter
  265 +<pre class='prettyprint linenums lang-js'>
  266 + coddoc -d ./lib -f markdown > README.md
245 267 </pre>
246   -<pre>
  268 +
247 269 To use the HTML formatter
248   -coddoc -d ./lib -f html > index.html
  270 +<pre class='prettyprint linenums lang-js'>
  271 + coddoc -d ./lib -f html > index.html
249 272 </pre>
250 273
251 274 To use pragmatically
252 275
253   -<pre>
  276 +<pre class='prettyprint linenums lang-js'>
  277 +
254 278 var coddoc = require("coddoc");
255 279 var tree = coddoc.parse({directory : __dirname + "/lib"});
256 280 var classes = tree.classes, namespaces = tree.namespaces;
257 281 //do something
  282 +
258 283 </pre>
259 284
260 285
@@ -416,10 +441,10 @@
416 441
417 442 <li> <em>options.dir</em> <code>String</code> : the directory of code to parse.</li>
418 443
419   - <li> <em>[options.pattern=/.+\.js$/i]</em> <code>RegExp</code> : a regular expression to test files agains</li>
  444 + <li> <em>[options.pattern= <code>/.+\.js$/i</code>]</em> <code>RegExp</code> : a regular expression to test files agains</li>
420 445
421 446 <li> <em>options.formatter?</em> <code>Object</code> : And optional formatter to format the tree. The object must contain
422   -a <code>generate</code> method. See <a href='#coddoc_formatters_html'>coddoc.formatters.html</a></li>
  447 +a <code>generate</code> method. See <a href='#coddoc_formatters_html'> coddoc.formatters.html</a></li>
423 448
424 449 </ul>
425 450
@@ -431,11 +456,10 @@
431 456 <pre class="prettyprint linenums lang-js">
432 457 function (options){
433 458 options = options || {};
434   - var baseDir = options.dir;
  459 + var baseDir = options.dir, filePattern = options.pattern || FILE_PATTERN;
435 460 if (!baseDir) {
436 461 console.log(&quot;directory required&quot;);
437 462 }
438   - var filePattern = options.pattern || FILE_PATTERN;
439 463 var fileMap = {};
440 464 (function findFiles(dir) {
441 465 var files = fs.readdirSync(dir);
@@ -448,18 +472,15 @@
448 472 fileMap[filePath] = fs.readFileSync(filePath, &quot;utf8&quot;);
449 473 }
450 474 });
451   - })(baseDir);
452   - var context = new Context();
453   - var tree = new Tree();
  475 + }(baseDir));
  476 + var context = new Context(), tree = new Tree();
454 477 Object.keys(fileMap).forEach(function (i, j) {
455   - context.activateScope(&quot;global&quot;)
456   - parser.parse(fileMap[i], path.relative(baseDir, i), tree, context);
  478 + emitter.emit(&quot;file&quot;, i);
  479 + context.activateScope(&quot;global&quot;);
  480 + parser.parse(fileMap[i], path.relative(baseDir, i), tree, context, emitter);
457 481 });
458   - var formatter = options.formatter, ret = tree;
459   - if (formatter &amp;&amp; formatter.generate) {
460   - ret = formatter.generate(tree);
461   - }
462   - return ret;
  482 + return tree;
  483 +
463 484 }
464 485 </pre>
465 486
@@ -554,10 +575,10 @@
554 575
555 576 <li> <em>regexp</em> : the regular expression used to match code blocks.</li>
556 577
557   - <li> <em>[priority=0]</em> : the priority to give this code handler if not provided
  578 + <li> <em>[priority= <code>0</code>]</em> : the priority to give this code handler if not provided
558 579 it is defaulted to 0.</li>
559 580
560   - <li> <em>parse</em> : a function that returns an object. The object will be set as the <code>codeObject</code> on the <a href='#coddoc_Symbol'>coddoc.Symbol</a>. The properties of the object will be added to the <a href='#coddoc_Symbol'>coddoc.Symbol</a> for processing later.</li>
  581 + <li> <em>parse</em> : a function that returns an object. The object will be set as the <code>codeObject</code> on the <a href='#coddoc_Symbol'> coddoc.Symbol</a>. The properties of the object will be added to the <a href='#coddoc_Symbol'> coddoc.Symbol</a> for processing later.</li>
561 582
562 583 </ul>
563 584
@@ -568,18 +589,19 @@
568 589 <em>Source</em>
569 590 <pre class="prettyprint linenums lang-js">
570 591 function (regexp,priority,parse){
571   - if(util.isFunction(priority)){
572   - parse = priority
  592 + if (util.isFunction(priority)) {
  593 + parse = priority;
573 594 priority = 0;
574 595 }
575 596 handlers.push({
576   - priority : priority,
  597 + priority:priority,
577 598 match:function (str) {
578 599 return regexp.exec(str);
579 600 },
580 601 parse:parse
581 602 });
582 603 handlers.sort(sortHandlers);
  604 +
583 605 }
584 606 </pre>
585 607
@@ -606,7 +628,7 @@
606 628 <em>Defined parser/tags.js</em>
607 629
608 630 <p>
609   -Adds a new tag to be parsed. You can use this to add custom tags. <a href='#coddoc'>coddoc</a> will
  631 +Adds a new tag to be parsed. You can use this to add custom tags. <a href='#coddoc'> coddoc</a> will
610 632 not do anything with the new tag by default, however you can add functionality to handle the
611 633 new tag in the template.
612 634
@@ -668,6 +690,7 @@
668 690 return {tag:tag, props:{}};
669 691 }};
670 692 });
  693 +
671 694 }
672 695 </pre>
673 696
@@ -714,6 +737,7 @@
714 737 <pre class="prettyprint linenums lang-js">
715 738 function (){
716 739 return new RegExp(&quot;@(&quot; + Object.keys(tags).join(&quot;|&quot;) + &quot;)&quot;);
  740 +
717 741 }
718 742 </pre>
719 743
@@ -740,7 +764,7 @@
740 764 <em>Defined parser/index.js</em>
741 765
742 766 <p>
743   -Parses a string of code into <a href='#coddoc_Symbol'>coddoc.Symbol</a>s. All processed symbols are added to the <a href='#coddoc_Tree'>coddoc.Tree</a>.
  767 +Parses a string of code into <a href='#coddoc_Symbol'> coddoc.Symbol</a>s. All processed symbols are added to the <a href='#coddoc_Tree'> coddoc.Tree</a>.
744 768 This method is not intended to be used directly by user code.
745 769
746 770 </p>
@@ -757,6 +781,8 @@
757 781
758 782 <li> <em>context</em> : the context which holds information about the current parsing job.</li>
759 783
  784 + <li> <em>emitter</em> : </li>
  785 +
760 786 </ul>
761 787
762 788
@@ -772,26 +798,26 @@
772 798
773 799 <em>Source</em>
774 800 <pre class="prettyprint linenums lang-js">
775   -function (str,filepath,tree,context){
  801 +function (str,filepath,tree,context,emitter){
776 802 var l = str.length;
777 803 var symbols = [];
778 804 for (var i = 0; i &lt; l; i++) {
779 805 var tags = [];
780 806 var comment = &quot;&quot;, c = str[i], startIndex = i, endIndex, ret = [];
781 807 var startCIndex = str.indexOf(&quot;/**&quot;, i);
782   - if (startCIndex != -1) {
  808 + if (startCIndex !== -1) {
783 809 i = startCIndex + 2;
784 810 var endCIndex = str.indexOf(&quot;*/&quot;, i);
785   - if (endCIndex != -1) {
786   - comment = str.substr(startCIndex + 2, endCIndex - (startCIndex + 2)).split(&quot;\n&quot;).map(
787   - function (str) {
788   - return str.replace(/^\s*\*\s?/, &quot;&quot;)
789   - }).join(&quot;\n&quot;);
  811 + if (endCIndex !== -1) {
  812 + comment = str.substr(startCIndex + 2, endCIndex - (startCIndex + 2)).split(&quot;\n&quot;).map(joinAndReplace).join(&quot;\n&quot;);
  813 + emitter.emit(&quot;comment&quot;, comment);
790 814 i = endCIndex + 1;
791 815 //console.log(str.substr(startCIndex, endCIndex - startCIndex));
792 816 //console.log(comment);
793   - var sym = parseTags({comment:comment, start:startCIndex, end:endCIndex + 2}, str, filepath, context);
  817 + var res = parseTags({comment:comment, start:startCIndex, end:endCIndex + 2}, str, filepath, context),
  818 + sym = res.symbol;
794 819 symbols.push(sym);
  820 + emitter.emit(&quot;symbol&quot;, sym);
795 821 var memberof = sym.memberof;
796 822 if (!sym.ignore &amp;&amp; !sym.lends) {
797 823 tree.addSymbol(sym);
@@ -802,6 +828,7 @@
802 828 }
803 829 }
804 830 return {symbols:symbols, code:str};
  831 +
805 832 }
806 833 </pre>
807 834
@@ -829,7 +856,7 @@
829 856
830 857 <p>
831 858 Uses Registered handlers to parse the next block of code from a code fragment. This function is
832   -used by <a href='#coddoc_parse'>coddoc.parse</a> to parse code for comments.
  859 +used by <a href='#coddoc_parse'> coddoc.parse</a> to parse code for comments.
833 860
834 861 </p>
835 862
@@ -860,10 +887,13 @@
860 887 break;
861 888 }
862 889 }
863   - symbol.codeObject = ret;
864   - for (var i in ret) {
865   - symbol[i] = ret[i];
  890 + if (ret) {
  891 + symbol.codeObject = ret;
  892 + Object.keys(ret).forEach(function (i) {
  893 + symbol[i] = ret[i];
  894 + });
866 895 }
  896 +
867 897 }
868 898 </pre>
869 899
@@ -891,8 +921,8 @@
891 921
892 922 <p>
893 923 Parses a tag and the coresponding comment using a matching tag handler. Each parsed tag
894   -could add a new property to the <a href='#coddoc_Symbol'>coddoc.Symbol</a>. The parsed tag will be added the the
895   -<a href='#coddoc_Symbol_prototype_tags'>coddoc.Symbol#tags</a> array.
  924 +could add a new property to the <a href='#coddoc_Symbol'> coddoc.Symbol</a>. The parsed tag will be added the the
  925 +<a href='#coddoc_Symbol_prototype_tags'> coddoc.Symbol#tags</a> array.
896 926
897 927 </p>
898 928
@@ -912,14 +942,14 @@
912 942 <em>Arguments</em>
913 943 <ul>
914 944
915   - <li> <em>tag</em> : the tag name being parsed from the comment</li>
916   -
917 945 <li> <em>comment</em> : the comment fragment being parsed</li>
918 946
919 947 <li> <em>sym</em> : the symbol that the comment corresponds to. The code object and values will have already been set.</li>
920 948
921 949 <li> <em>context</em> : the currect context object. The context allows tags to set new scopes and namespaces.</li>
922 950
  951 + <li> <em>tag</em> <code>String</code> : the tag name being parsed from the comment</li>
  952 +
923 953 </ul>
924 954
925 955
@@ -928,13 +958,17 @@
928 958
929 959 <em>Source</em>
930 960 <pre class="prettyprint linenums lang-js">
931   -function (tag,comment,sym,context){
932   - var t = tags[tag];
933   - if (t) {
934   - t.parse(comment, sym, context)
935   - } else {
936   - throw new Error(&quot;Invalid tag &quot; + tag);
  961 +function (comment,sym,context){
  962 + var tag = comment.match(TAG_REGEXP), ret = {};
  963 + if (tag &amp;&amp; tag.length === 2) {
  964 + var t = tags[tag[1]];
  965 + if (t) {
  966 + t.parse(comment, sym, context);
  967 + } else {
  968 + throw new Error(&quot;Invalid tag &quot; + tag);
  969 + }
937 970 }
  971 +
938 972 }
939 973 </pre>
940 974
@@ -975,8 +1009,6 @@
975 1009
976 1010 <li><a href="#coddoc_Context_prototype_activateScope">
977 1011
978   - <span class="label label-info">S</span>
979   -
980 1012
981 1013 <span class="label label-label">F</span>
982 1014
@@ -991,8 +1023,6 @@
991 1023
992 1024 <li><a href="#coddoc_Context_prototype_addNamespace">
993 1025
994   - <span class="label label-info">S</span>
995   -
996 1026
997 1027 <span class="label label-label">F</span>
998 1028
@@ -1007,8 +1037,6 @@
1007 1037
1008 1038 <li><a href="#coddoc_Context_prototype_addScope">
1009 1039
1010   - <span class="label label-info">S</span>
1011   -
1012 1040
1013 1041 <span class="label label-label">F</span>
1014 1042
@@ -1023,8 +1051,6 @@
1023 1051
1024 1052 <li><a href="#coddoc_Context_prototype_getActiveScope">
1025 1053
1026   - <span class="label label-info">S</span>
1027   -
1028 1054
1029 1055 <span class="label label-label">F</span>
1030 1056
@@ -1039,8 +1065,6 @@
1039 1065
1040 1066 <li><a href="#coddoc_Context_prototype_getActiveScopeName">
1041 1067
1042   - <span class="label label-info">S</span>
1043   -
1044 1068
1045 1069 <span class="label label-label">F</span>
1046 1070
@@ -1055,8 +1079,6 @@
1055 1079
1056 1080 <li><a href="#coddoc_Context_prototype_getNamespace">
1057 1081
1058   - <span class="label label-info">S</span>
1059   -
1060 1082
1061 1083 <span class="label label-label">F</span>
1062 1084
@@ -1071,8 +1093,6 @@
1071 1093
1072 1094 <li><a href="#coddoc_Context_prototype_getScope">
1073 1095
1074   - <span class="label label-info">S</span>
1075   -
1076 1096
1077 1097 <span class="label label-label">F</span>
1078 1098
@@ -1123,6 +1143,7 @@
1123 1143 this.nameSpaces = {global:[]};
1124 1144 this.aliases = {};
1125 1145 this.activateScope(&quot;global&quot;);
  1146 +
1126 1147 }
1127 1148 </pre>
1128 1149
@@ -1134,8 +1155,6 @@
1134 1155 <h3>
1135 1156 activateScope
1136 1157
1137   - <span class="label label-info">Static</span>
1138   -
1139 1158
1140 1159 <span class="label label-label">Function</span>
1141 1160
@@ -1177,6 +1196,7 @@
1177 1196 function (name){
1178 1197 this.activeScope = name;
1179 1198 return this.addScope(name);
  1199 +
1180 1200 }
1181 1201 </pre>
1182 1202
@@ -1187,8 +1207,6 @@
1187 1207 <h3>
1188 1208 addNamespace
1189 1209
1190   - <span class="label label-info">Static</span>
1191   -
1192 1210
1193 1211 <span class="label label-label">Function</span>
1194 1212
@@ -1232,6 +1250,7 @@
1232 1250 this.nameSpaces[name] = {};
1233 1251 }
1234 1252 return this.nameSpaces[name];
  1253 +
1235 1254 }
1236 1255 </pre>
1237 1256
@@ -1242,8 +1261,6 @@
1242 1261 <h3>
1243 1262 addScope
1244 1263
1245   - <span class="label label-info">Static</span>
1246   -
1247 1264
1248 1265 <span class="label label-label">Function</span>
1249 1266
@@ -1288,6 +1305,7 @@
1288 1305 this.scopes[name] = {};
1289 1306 }
1290 1307 return this.scopes[name];
  1308 +
1291 1309 }
1292 1310 </pre>
1293 1311
@@ -1298,8 +1316,6 @@
1298 1316 <h3>
1299 1317 getActiveScope
1300 1318
1301   - <span class="label label-info">Static</span>
1302   -
1303 1319
1304 1320 <span class="label label-label">Function</span>
1305 1321
@@ -1334,6 +1350,7 @@
1334 1350 <pre class="prettyprint linenums lang-js">
1335 1351 function (){
1336 1352 return this.getScope(this.activeScope);
  1353 +
1337 1354 }
1338 1355 </pre>
1339 1356
@@ -1344,8 +1361,6 @@
1344 1361 <h3>
1345 1362 getActiveScopeName
1346 1363
1347   - <span class="label label-info">Static</span>
1348   -
1349 1364
1350 1365 <span class="label label-label">Function</span>
1351 1366
@@ -1380,6 +1395,7 @@
1380 1395 <pre class="prettyprint linenums lang-js">
1381 1396 function (){
1382 1397 return this.activeScope;
  1398 +
1383 1399 }
1384 1400 </pre>
1385 1401
@@ -1390,8 +1406,6 @@
1390 1406 <h3>
1391 1407 getNamespace
1392 1408
1393   - <span class="label label-info">Static</span>
1394   -
1395 1409
1396 1410 <span class="label label-label">Function</span>
1397 1411
@@ -1433,6 +1447,7 @@
1433 1447 <pre class="prettyprint linenums lang-js">
1434 1448 function (name){
1435 1449 return this.addNamespace(name);
  1450 +
1436 1451 }
1437 1452 </pre>
1438 1453
@@ -1443,8 +1458,6 @@
1443 1458 <h3>
1444 1459 getScope
1445 1460
1446   - <span class="label label-info">Static</span>
1447   -
1448 1461
1449 1462 <span class="label label-label">Function</span>
1450 1463
@@ -1486,6 +1499,7 @@
1486 1499 <pre class="prettyprint linenums lang-js">
1487 1500 function (name){
1488 1501 return this.addScope(name);
  1502 +
1489 1503 }
1490 1504 </pre>
1491 1505
@@ -1527,9 +1541,9 @@
1527 1541
1528 1542
1529 1543 <p>
1530   -A Symbol represents a comment and code pair. Each code handler added through <a href='#coddoc_addCodeHandler'>coddoc.addCodeHandler</a> and
1531   -tag handler added through <a href='#coddoc_addTagHandler'>coddoc.addTagHandler</a> adds/removes properties from a the symbol. Each symbol is
1532   -added to the <a href='#coddoc_Tree'>coddoc.Tree</a> which is either returned from <a href='#coddoc'>coddoc</a> or passed into a template handler.
  1544 +A Symbol represents a comment and code pair. Each code handler added through <a href='#coddoc_addCodeHandler'> coddoc.addCodeHandler</a> and
  1545 +tag handler added through <a href='#coddoc_addTagHandler'> coddoc.addTagHandler</a> adds/removes properties from a the symbol. Each symbol is
  1546 +added to the <a href='#coddoc_Tree'> coddoc.Tree</a> which is either returned from <a href='#coddoc'> coddoc</a> or passed into a template handler.
1533 1547
1534 1548 <b>NOTE: This object should not be instantiated by user code</b>
1535 1549
@@ -1543,69 +1557,71 @@
1543 1557
1544 1558 <a name="coddoc_Symbol_instanceProperties"></a>
1545 1559 <em>Instance Properties</em>
1546   - <table class='table table-bordered table-striped'><tr><td>Property</td><td>Type</td><td>Default Value</td><td>Description</td></tr><tr><td><em>augments</em></td><td>{Array}</td><td><code>
  1560 + <table class='table table-bordered table-striped'><tr><td>Property</td><td>Type</td><td>Default Value</td><td>Description</td></tr><tr><td>augments</td><td>{Array}</td><td><code>
1547 1561 []
1548   - </code></td><td>
  1562 + </code></td><td>
1549 1563 Any symbols this symbol augments
1550   -</td><tr><tr><td><em>borrows</em></td><td>{Array}</td><td><code>
  1564 +</td><tr><tr><td>borrows</td><td>{Array}</td><td><code>
1551 1565 []
1552   - </code></td><td>
  1566 + </code></td><td>
1553 1567 Any properties this symbol borrows
1554   -</td><tr><tr><td><em>codeObject</em></td><td>{Object}</td><td><code>null</code></td><td>
  1568 +</td><tr><tr><td>codeObject</td><td>{Object}</td><td><code>null</code></td><td>
1555 1569 The codeObject of this symbol
1556   -</td><tr><tr><td><em>description</em></td><td>{String}</td><td><code>""</code></td><td>
  1570 +</td><tr><tr><td>description</td><td>{String}</td><td><code>""</code></td><td>
1557 1571 The description of this symbol.
1558   -</td><tr><tr><td><em>examples</em></td><td>{Array}</td><td><code>
  1572 +</td><tr><tr><td>examples</td><td>{Array}</td><td><code>
1559 1573 []
1560   - </code></td><td>
  1574 + </code></td><td>
1561 1575 The examples for this symbol
1562   -</td><tr><tr><td><em>file</em></td><td>{String}</td><td><code>""</code></td><td>
  1576 +</td><tr><tr><td>file</td><td>{String}</td><td><code>""</code></td><td>
1563 1577 The file where the symbol was found.
1564   -</td><tr><tr><td><em>fullname</em></td><td>{String}</td><td><code>""</code></td><td>
  1578 +</td><tr><tr><td>fullname</td><td>{String}</td><td><code>""</code></td><td>
1565 1579 The fullname i.e ({memberof}.{name})
1566   -</td><tr><tr><td><em>ignoreCode</em></td><td>{Boolean}</td><td><code>false</code></td><td>
  1580 +</td><tr><tr><td>ignore</td><td>{Boolean}</td><td><code>false</code></td><td>
  1581 +Set to true if the symbol should be ignored and not put into <a href='#coddoc_Tree'> coddoc.Tree</a>
  1582 +</td><tr><tr><td>ignoreCode</td><td>{Boolean}</td><td><code>false</code></td><td>
1567 1583 Set to true if the code object from this symbol should be ignored.
1568   -</td><tr><tr><td><em>isConstant</em></td><td>{Boolean}</td><td><code>false</code></td><td>
  1584 +</td><tr><tr><td>isConstant</td><td>{Boolean}</td><td><code>false</code></td><td>
1569 1585 Set to true if this symbol is a constant.
1570   -</td><tr><tr><td><em>isConstructor</em></td><td>{Boolean}</td><td><code>false</code></td><td>
  1586 +</td><tr><tr><td>isConstructor</td><td>{Boolean}</td><td><code>false</code></td><td>
1571 1587 Set to true is this symbol is a constructor
1572   -</td><tr><tr><td><em>isFunction</em></td><td>{Boolean}</td><td><code>false</code></td><td>
  1588 +</td><tr><tr><td>isFunction</td><td>{Boolean}</td><td><code>false</code></td><td>
1573 1589 Set to true if this symbol is a function.
1574   -</td><tr><tr><td><em>isPrivate</em></td><td>{Boolean}</td><td><code>false</code></td><td>
  1590 +</td><tr><tr><td>isPrivate</td><td>{Boolean}</td><td><code>false</code></td><td>
1575 1591 Set to true if this symbol is private.
1576   -</td><tr><tr><td><em>isProtected</em></td><td>{Boolean}</td><td><code>false</code></td><td>
  1592 +</td><tr><tr><td>isProtected</td><td>{Boolean}</td><td><code>false</code></td><td>
1577 1593 Set to true if this symbol is protected.
1578   -</td><tr><tr><td><em>isStatic</em></td><td>{Boolean}</td><td><code>false</code></td><td>
  1594 +</td><tr><tr><td>isStatic</td><td>{Boolean}</td><td><code>false</code></td><td>
1579 1595 Set to true if this symbol is static
1580   -</td><tr><tr><td><em>memberof</em></td><td>{String}</td><td><code>""</code></td><td>
  1596 +</td><tr><tr><td>memberof</td><td>{String}</td><td><code>""</code></td><td>
1581 1597 Who this symbol belongs to.
1582   -</td><tr><tr><td><em>name</em></td><td>{String}</td><td><code>""</code></td><td>
  1598 +</td><tr><tr><td>name</td><td>{String}</td><td><code>""</code></td><td>
1583 1599 The name of this symbol
1584   -</td><tr><tr><td><em>params</em></td><td>{Array}</td><td><code>
  1600 +</td><tr><tr><td>params</td><td>{Array}</td><td><code>
1585 1601 []
1586   - </code></td><td>
  1602 + </code></td><td>
1587 1603 The associated params for this symbol if it is a funciton.
1588   -</td><tr><tr><td><em>properties</em></td><td>{Array}</td><td><code>
  1604 +</td><tr><tr><td>properties</td><td>{Array}</td><td><code>
1589 1605 []
1590   - </code></td><td>
  1606 + </code></td><td>
1591 1607 The associated properties for this symbol
1592   -</td><tr><tr><td><em>returns</em></td><td>{Array}</td><td><code>
  1608 +</td><tr><tr><td>returns</td><td>{Array}</td><td><code>
1593 1609 []
1594   - </code></td><td>
  1610 + </code></td><td>
1595 1611 Array of return types for this symbol
1596   -</td><tr><tr><td><em>see</em></td><td>{Array}</td><td><code>
  1612 +</td><tr><tr><td>see</td><td>{Array}</td><td><code>
1597 1613 []
1598   - </code></td><td>
  1614 + </code></td><td>
1599 1615 Any link for this symbol
1600   -</td><tr><tr><td><em>tags</em></td><td>{Array}</td><td><code>
  1616 +</td><tr><tr><td>tags</td><td>{Array}</td><td><code>
1601 1617 []
1602   - </code></td><td>
  1618 + </code></td><td>
1603 1619 The associated tags for this symbol
1604   -</td><tr><tr><td><em>throws</em></td><td>{Array}</td><td><code>
  1620 +</td><tr><tr><td>throws</td><td>{Array}</td><td><code>
1605 1621 []
1606   - </code></td><td>
  1622 + </code></td><td>
1607 1623 Exceptions thrown by this symbol
1608   -</td><tr><tr><td><em>type</em></td><td>{*}</td><td><code>null</code></td><td>
  1624 +</td><tr><tr><td>type</td><td>{*}</td><td><code>null</code></td><td>
1609 1625 The type that is symbol represents.
1610 1626 </td><tr></table>
1611 1627
@@ -1634,13 +1650,17 @@
1634 1650 this.examples = [];
1635 1651 this.borrows = [];
1636 1652 this.augments = [];
  1653 + this.includedDocs = [];
1637 1654 this.see = [];
1638 1655 this.throws = [];
1639 1656 this.returns = [];
1640 1657 options = options || {};
1641 1658 for (var i in options) {
1642   - this[i] = options[i];
  1659 + if (i in this) {
  1660 + this[i] = options[i];
  1661 + }
1643 1662 }
  1663 +
1644 1664 }
1645 1665 </pre>
1646 1666
@@ -1678,8 +1698,6 @@
1678 1698
1679 1699 <li><a href="#coddoc_Tree_prototype__addSymbol">
1680 1700
1681   - <span class="label label-info">S</span>
1682   -
1683 1701
1684 1702 <span class="label label-label">F</span>
1685 1703
@@ -1692,8 +1710,6 @@
1692 1710
1693 1711 <li><a href="#coddoc_Tree_prototype_addSymbol">
1694 1712
1695   - <span class="label label-info">S</span>
1696   -
1697 1713
1698 1714 <span class="label label-label">F</span>
1699 1715
@@ -1708,8 +1724,6 @@
1708 1724
1709 1725 <li><a href="#coddoc_Tree_prototype_getClasses">
1710 1726
1711   - <span class="label label-info">S</span>
1712   -
1713 1727
1714 1728 <span class="label label-label">F</span>
1715 1729
@@ -1724,8 +1738,6 @@
1724 1738
1725 1739 <li><a href="#coddoc_Tree_prototype_getMembers">
1726 1740
1727   - <span class="label label-info">S</span>
1728   -
1729 1741
1730 1742 <span class="label label-label">F</span>
1731 1743
@@ -1740,8 +1752,6 @@
1740 1752
1741 1753 <li><a href="#coddoc_Tree_prototype_getNamespaces">
1742 1754
1743   - <span class="label label-info">S</span>
1744   -
1745 1755
1746 1756 <span class="label label-label">F</span>
1747 1757
@@ -1756,8 +1766,6 @@
1756 1766
1757 1767 <li><a href="#coddoc_Tree_prototype_getSymbol">
1758 1768
1759   - <span class="label label-info">S</span>
1760   -
1761 1769
1762 1770 <span class="label label-label">F</span>
1763 1771
@@ -1772,8 +1780,6 @@
1772 1780
1773 1781 <li><a href="#coddoc_Tree_prototype_hasSymbol">
1774 1782
1775   - <span class="label label-info">S</span>
1776   -
1777 1783
1778 1784 <span class="label label-label">F</span>
1779 1785
@@ -1820,6 +1826,7 @@
1820 1826 <pre class="prettyprint linenums lang-js">
1821 1827 function (){
1822 1828 this.symbols = {global:[]};
  1829 +
1823 1830 }
1824 1831 </pre>
1825 1832
@@ -1831,8 +1838,6 @@
1831 1838 <h3>
1832 1839 _addSymbol
1833 1840
1834   - <span class="label label-info">Static</span>
1835   -
1836 1841
1837 1842 <span class="label label-label">Function</span>
1838 1843
@@ -1875,6 +1880,7 @@
1875 1880 ret = this.symbols[name] = [];
1876 1881 }
1877 1882 return ret;
  1883 +
1878 1884 }
1879 1885 </pre>
1880 1886
@@ -1885,8 +1891,6 @@
1885 1891 <h3>
1886 1892 addSymbol
1887 1893
1888   - <span class="label label-info">Static</span>
1889   -
1890 1894
1891 1895 <span class="label label-label">Function</span>
1892 1896
@@ -1925,10 +1929,14 @@
1925 1929 <em>Source</em>
1926 1930 <pre class="prettyprint linenums lang-js">
1927 1931 function (symbol){
1928   - var path = symbol.memberof, name = symbol.name;
1929   - path == &quot;global&quot; &amp;&amp; (path = name);
  1932 + var nameParts = utils.splitName(symbol.fullName);
  1933 + var path = nameParts.memberof, name = nameParts.name;
  1934 + if (path === &quot;global&quot;) {
  1935 + path = name;
  1936 + }
1930 1937 var sym = this.getSymbol(path);
1931 1938 sym.push(symbol);
  1939 +
1932 1940 }
1933 1941 </pre>
1934 1942
@@ -1939,8 +1947,6 @@
1939 1947 <h3>
1940 1948 getClasses
1941 1949
1942   - <span class="label label-info">Static</span>
1943   -
1944 1950
1945 1951 <span class="label label-label">Function</span>
1946 1952
@@ -1993,7 +1999,7 @@
1993 1999 var name = s.fullName;
1994 2000 var statics = symbols[name] || [];
1995 2001 var instance = symbols[name + &quot;.prototype&quot;] || [];
1996   - var borrowedMethods = [], borrowedProperties = [], staticBorrowedMethods = [], staticBorrowedProperties = []
  2002 + var borrowedMethods = [], borrowedProperties = [], staticBorrowedMethods = [], staticBorrowedProperties = [];
1997 2003 s.borrows.map(function (b) {
1998 2004 var borrows = b.borrows;
1999 2005 var symbol = symbols[borrows.memberof || &quot;global&quot;].filter(function (s) {
@@ -2026,7 +2032,6 @@
2026 2032 s.staticProperties = statics.filter(
2027 2033 function (s) {
2028 2034 return !s.isFunction &amp;&amp; !s.isNamespace;
2029   - ;
2030 2035 }).concat(staticBorrowedProperties);
2031 2036 s.instanceMethods = instance.filter(
2032 2037 function (s) {
@@ -2038,6 +2043,7 @@
2038 2043 }).concat(s.properties || []).concat(borrowedProperties);
2039 2044 return s;
2040 2045 });
  2046 +
2041 2047 }
2042 2048 </pre>
2043 2049
@@ -2048,8 +2054,6 @@
2048 2054 <h3>
2049 2055 getMembers
2050 2056
2051   - <span class="label label-info">Static</span>
2052   -
2053 2057
2054 2058 <span class="label label-label">Function</span>
2055 2059
@@ -2064,7 +2068,7 @@
2064 2068 <em>Defined tree.js</em>
2065 2069
2066 2070 <p>
2067   -Gets all members(<a href='#coddoc_Symbol'>coddoc.Symbol</a>) for a particular path.
  2071 +Gets all members(<a href='#coddoc_Symbol'> coddoc.Symbol</a>) for a particular path.
2068 2072 </p>
2069 2073
2070 2074
@@ -2098,6 +2102,7 @@
2098 2102 }));
2099 2103 });
2100 2104 return namespaces;
  2105 +
2101 2106 }
2102 2107 </pre>
2103 2108
@@ -2108,8 +2113,6 @@
2108 2113 <h3>
2109 2114 getNamespaces
2110 2115
2111   - <span class="label label-info">Static</span>
2112   -
2113 2116
2114 2117 <span class="label label-label">Function</span>
2115 2118
@@ -2157,17 +2160,18 @@
2157 2160 }));
2158 2161 });
2159 2162 return namespaces.map(function (s) {
2160   - var realName = s.memberof &amp;&amp; s.memberof != &quot;global&quot; ? [s.memberof, s.name].join(&quot;.&quot;) : s.name;
  2163 + var realName = s.memberof &amp;&amp; s.memberof !== &quot;global&quot; ? [s.memberof, s.name].join(&quot;.&quot;) : s.name;
2161 2164 var members = this.getMembers(realName);
2162 2165 s.name = realName;
2163   - s.properties = members.filter(function (m) {
  2166 + s.properties = s.properties.concat(members.filter(function (m) {
2164 2167 return !m.isFunction;
2165   - });
  2168 + }));
2166 2169 s.methods = members.filter(function (m) {
2167 2170 return m.isFunction;
2168 2171 });
2169 2172 return s;
2170 2173 }, this);
  2174 +
2171 2175 }
2172 2176 </pre>
2173 2177
@@ -2178,8 +2182,6 @@
2178 2182 <h3>
2179 2183 getSymbol
2180 2184
2181   - <span class="label label-info">Static</span>
2182   -
2183 2185
2184 2186 <span class="label label-label">Function</span>
2185 2187
@@ -2221,6 +2223,7 @@
2221 2223 <pre class="prettyprint linenums lang-js">
2222 2224 function (name){
2223 2225 return this._addSymbol(name);
  2226 +
2224 2227 }
2225 2228 </pre>
2226 2229
@@ -2231,8 +2234,6 @@
2231 2234 <h3>
2232 2235 hasSymbol
2233 2236
2234   - <span class="label label-info">Static</span>
2235   -
2236 2237
2237 2238 <span class="label label-label">Function</span>
2238 2239
@@ -2275,6 +2276,7 @@
2275 2276 function (name){
2276 2277 var parts = name.split(&quot;.&quot;);
2277 2278 return !!this.symbols[name];
  2279 +
2278 2280 }
2279 2281 </pre>
2280 2282
@@ -2285,11 +2287,11 @@
2285 2287
2286 2288 <h2>License</h2>
2287 2289
2288   -<p>MIT <a href = https://github.com/Pollenware/downdoc/raw/master/LICENSE>LICENSE</a><p>
  2290 +<p>MIT <a href = https://github.com/Pollenware/coddoc/raw/master/LICENSE>LICENSE</a><p>
2289 2291
2290 2292 <h2>Meta</h2>
2291 2293 <hr>
2292   -<p>Code: <code>git clone git://github.com/pollenware/downdoc.git</code></br></p>
  2294 +<p>Code: <code>git clone git://github.com/pollenware/coddoc.git</code></br></p>
2293 2295
2294 2296 </div>
2295 2297 </div>
77 README.md
Source Rendered
@@ -6,7 +6,7 @@
6 6 <h2> Description</h2>
7 7 <p>
8 8 coddoc is a jsdoc parsing library. Coddoc is different in that it is easily extensible by allowing users to
9   - add tag and code parsers through the use of <a href='# coddoc_addTagHandler'> coddoc.addTagHandler</a> and <a href='# coddoc_addCodeHandler'> coddoc.addCodeHandler</a>.
  9 + add tag and code parsers through the use of <a href='#coddoc_addTagHandler'> coddoc.addTagHandler</a> and <a href='#coddoc_addCodeHandler'> coddoc.addCodeHandler</a>.
10 10 coddoc also parses source code to be used in APIs.
11 11 </p>
12 12
@@ -161,7 +161,7 @@ Entry point for parsing code.
161 161
162 162
163 163 ---
164   -*Defined * [Top](#top)
  164 +*Defined parser/code.js* [Top](#top)
165 165
166 166
167 167 Adds a handler for a particular code regular expression. Useful if you want to
@@ -236,7 +236,7 @@ addHandler(/^var *\w+ *= * (\w+(?:\.\w+)*) = *function/, 20, function (str, symb
236 236 * _[priority=0]_ : the priority to give this code handler if not provided
237 237 it is defaulted to 0.
238 238
239   - * _parse_ : a function that returns an object. The object will be set as the <code>codeObject</code> on the <a href='# coddoc_Symbol'> coddoc.Symbol</a>. The properties of the object will be added to the <a href='# coddoc_Symbol'> coddoc.Symbol</a> for processing later.
  239 + * _parse_ : a function that returns an object. The object will be set as the <code>codeObject</code> on the <a href='#coddoc_Symbol'> coddoc.Symbol</a>. The properties of the object will be added to the <a href='#coddoc_Symbol'> coddoc.Symbol</a> for processing later.
240 240
241 241
242 242
@@ -271,10 +271,10 @@ function (regexp,priority,parse){
271 271
272 272
273 273 ---
274   -*Defined * [Top](#top)
  274 +*Defined parser/tags.js* [Top](#top)
275 275
276 276
277   -Adds a new tag to be parsed. You can use this to add custom tags. <a href='# coddoc'> coddoc</a> will
  277 +Adds a new tag to be parsed. You can use this to add custom tags. <a href='#coddoc'> coddoc</a> will
278 278 not do anything with the new tag by default, however you can add functionality to handle the
279 279 new tag in the template.
280 280
@@ -349,7 +349,7 @@ function (tag,parse){
349 349
350 350
351 351 ---
352   -*Defined * [Top](#top)
  352 +*Defined parser/tags.js* [Top](#top)
353 353
354 354
355 355 Returns a regular expression that can be used to parse tags
@@ -383,10 +383,10 @@ function (){
383 383
384 384
385 385 ---
386   -*Defined * [Top](#top)
  386 +*Defined parser/index.js* [Top](#top)
387 387
388 388
389   -Parses a string of code into <a href='# coddoc_Symbol'> coddoc.Symbol</a>s. All processed symbols are added to the <a href='# coddoc_Tree'> coddoc.Tree</a>.
  389 +Parses a string of code into <a href='#coddoc_Symbol'> coddoc.Symbol</a>s. All processed symbols are added to the <a href='#coddoc_Tree'> coddoc.Tree</a>.
390 390 This method is not intended to be used directly by user code.
391 391
392 392
@@ -460,11 +460,11 @@ function (str,filepath,tree,context,emitter){
460 460
461 461
462 462 ---
463   -*Defined * [Top](#top)
  463 +*Defined parser/code.js* [Top](#top)
464 464
465 465
466 466 Uses Registered handlers to parse the next block of code from a code fragment. This function is
467   -used by <a href='# coddoc_parse'> coddoc.parse</a> to parse code for comments.
  467 +used by <a href='#coddoc_parse'> coddoc.parse</a> to parse code for comments.
468 468
469 469
470 470
@@ -513,12 +513,12 @@ function (str,symbol,context){
513 513
514 514
515 515 ---
516   -*Defined * [Top](#top)
  516 +*Defined parser/tags.js* [Top](#top)
517 517
518 518
519 519 Parses a tag and the coresponding comment using a matching tag handler. Each parsed tag
520   -could add a new property to the <a href='# coddoc_Symbol'> coddoc.Symbol</a>. The parsed tag will be added the the
521   -<a href='# coddoc_Symbol_prototype_tags'> coddoc.Symbol#tags</a> array.
  520 +could add a new property to the <a href='#coddoc_Symbol'> coddoc.Symbol</a>. The parsed tag will be added the the
  521 +<a href='#coddoc_Symbol_prototype_tags'> coddoc.Symbol#tags</a> array.
522 522
523 523
524 524
@@ -614,7 +614,7 @@ The context should not be used directly by user code.
614 614
615 615 ###Constructor
616 616
617   -*Defined * [Top](#top)
  617 +*Defined context.js* [Top](#top)
618 618
619 619
620 620
@@ -641,7 +641,7 @@ function (){
641 641
642 642
643 643 ---
644   -*Defined * [Top](#top)
  644 +*Defined context.js* [Top](#top)
645 645
646 646
647 647 Activates a scope for.
@@ -681,7 +681,7 @@ function (name){
681 681
682 682
683 683 ---
684   -*Defined * [Top](#top)
  684 +*Defined context.js* [Top](#top)
685 685
686 686
687 687 Adds a namespace the the context object.
@@ -723,7 +723,7 @@ function (name){
723 723
724 724
725 725 ---
726   -*Defined * [Top](#top)
  726 +*Defined context.js* [Top](#top)
727 727
728 728
729 729 Adds a scope to the context
@@ -766,7 +766,7 @@ function (name){
766 766
767 767
768 768 ---
769   -*Defined * [Top](#top)
  769 +*Defined context.js* [Top](#top)
770 770
771 771
772 772 Returns the active scope.
@@ -800,7 +800,7 @@ function (){
800 800
801 801
802 802 ---
803   -*Defined * [Top](#top)
  803 +*Defined context.js* [Top](#top)
804 804
805 805
806 806 Returns the name of the active scope.
@@ -834,7 +834,7 @@ function (){
834 834
835 835
836 836 ---
837   -*Defined * [Top](#top)
  837 +*Defined context.js* [Top](#top)
838 838
839 839
840 840 Gets a namespace, creating it if it does not exist.
@@ -874,7 +874,7 @@ function (name){
874 874
875 875
876 876 ---
877   -*Defined * [Top](#top)
  877 +*Defined context.js* [Top](#top)
878 878
879 879
880 880 Gets a scope creating it if it does not exist.
@@ -915,9 +915,9 @@ function (name){
915 915 [Top](#top)
916 916
917 917
918   -A Symbol represents a comment and code pair. Each code handler added through <a href='# coddoc_addCodeHandler'> coddoc.addCodeHandler</a> and
919   -tag handler added through <a href='# coddoc_addTagHandler'> coddoc.addTagHandler</a> adds/removes properties from a the symbol. Each symbol is
920   -added to the <a href='# coddoc_Tree'> coddoc.Tree</a> which is either returned from <a href='# coddoc'> coddoc</a> or passed into a template handler.
  918 +A Symbol represents a comment and code pair. Each code handler added through <a href='#coddoc_addCodeHandler'> coddoc.addCodeHandler</a> and
  919 +tag handler added through <a href='#coddoc_addTagHandler'> coddoc.addTagHandler</a> adds/removes properties from a the symbol. Each symbol is
  920 +added to the <a href='#coddoc_Tree'> coddoc.Tree</a> which is either returned from <a href='#coddoc'> coddoc</a> or passed into a template handler.
921 921
922 922 <b>NOTE: This object should not be instantiated by user code</b>
923 923
@@ -952,7 +952,7 @@ The file where the symbol was found.
952 952 </td><tr><tr><td>fullname</td><td>{String}</td><td><code>""</code></td><td>
953 953 The fullname i.e ({memberof}.{name})
954 954 </td><tr><tr><td>ignore</td><td>{Boolean}</td><td><code>false</code></td><td>
955   -Set to true if the symbol should be ignored and not put into <a href='# coddoc_Tree'> coddoc.Tree</a>
  955 +Set to true if the symbol should be ignored and not put into <a href='#coddoc_Tree'> coddoc.Tree</a>
956 956 </td><tr><tr><td>ignoreCode</td><td>{Boolean}</td><td><code>false</code></td><td>
957 957 Set to true if the code object from this symbol should be ignored.
958 958 </td><tr><tr><td>isConstant</td><td>{Boolean}</td><td><code>false</code></td><td>
@@ -1005,7 +1005,7 @@ The type that is symbol represents.
1005 1005
1006 1006 ###Constructor
1007 1007
1008   -*Defined * [Top](#top)
  1008 +*Defined symbol.js* [Top](#top)
1009 1009
1010 1010 *Arguments*
1011 1011
@@ -1026,12 +1026,13 @@ function (options){
1026 1026 this.examples = [];
1027 1027 this.borrows = [];
1028 1028 this.augments = [];
  1029 + this.includedDocs = [];
1029 1030 this.see = [];
1030 1031 this.throws = [];
1031 1032 this.returns = [];
1032 1033 options = options || {};
1033 1034 for (var i in options) {
1034   - if (this.hasOwnProperty(i)) {
  1035 + if (i in this) {
1035 1036 this[i] = options[i];
1036 1037 }
1037 1038 }
@@ -1083,7 +1084,7 @@ A Tree object which contains symbols.
1083 1084
1084 1085 ###Constructor
1085 1086
1086   -*Defined * [Top](#top)
  1087 +*Defined tree.js* [Top](#top)
1087 1088
1088 1089
1089 1090
@@ -1107,7 +1108,7 @@ function (){
1107 1108
1108 1109
1109 1110 ---