Permalink
Browse files

updated docs

  • Loading branch information...
1 parent 97e30a3 commit f031d64460d7001fcb2662674bb7f9cf0d1bdb51 @doug-martin committed Jul 15, 2012
Showing with 23,008 additions and 2,301 deletions.
  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
View
322 README.html
@@ -119,9 +119,9 @@
<span class="icon-bar"></span>
</a>
- <a href="#" class="brand">coddoc</a>
+ <a href="./index.html" class="brand">coddoc</a>
- <div class="nav-collapse">
+ <div class="nav-collapse">
<ul class="nav nav-pills">
<li class="dropdown">
@@ -148,6 +148,11 @@
</li>
</ul>
+
+ <ul class="nav pull-right">
+ <li><a href="https://github.com/doug-martin/coddoc" target="#github" class="pull-right">github</a></li>
+ </ul>
+
</div>
</div>
</div>
@@ -163,7 +168,7 @@
<h2> Description</h2>
<p>
coddoc is a jsdoc parsing library. Coddoc is different in that it is easily extensible by allowing users to
- add tag and code parsers through the use of <a href='#coddoc_addTagHandler'>coddoc.addTagHandler</a> and <a href='#coddoc_addCodeHandler'>coddoc.addCodeHandler</a>.
+ add tag and code parsers through the use of <a href='#coddoc_addTagHandler'> coddoc.addTagHandler</a> and <a href='#coddoc_addCodeHandler'> coddoc.addCodeHandler</a>.
coddoc also parses source code to be used in APIs.
</p>
@@ -205,7 +210,19 @@
Coddoc also has a few additional tags.
<ul>
<li>ignoreCode : ignore the parsed code in the output</li>
+ <li>includeDoc : include an external doc. External docs can be html or markdown.
+ Example <pre class='prettyprint linenums lang-js'>
+ &#64;includeDoc [Title Of Doc] ../location/of_doc.md
+</pre>
+ </li>
<li>projectName : document the projectName</li>
+ <li>github : url to github project</li>
+ <li>code : specifies a code block without needing an <code>example</code> tag
+ Example <pre class='prettyprint linenums lang-js'>
+ &#123;&#64;code var test = "test"; &#125;
+</pre>
+ </li>
+
<li>header : allows you to document a header that should appear before
generated documentation</li>
<li>footer : allows you to document a footer that should come after the generated documentation</li>
@@ -215,12 +232,14 @@
<h2>Installation</h2>
Locally
-
-<pre>npm install coddoc</pre>
-
+<pre class='prettyprint linenums lang-js'>
+ npm install coddoc
+</pre>
Globally
-<pre>npm install -g coddoc</pre>
+<pre class='prettyprint linenums lang-js'>
+ npm install -g coddoc
+</pre>
<h2>Usage</h2>
Down doc does not currently create multi file docs instead will output to a single file. You may however implement
@@ -236,25 +255,31 @@
</ul>
Examples
-<pre>
-coddoc -d ./lib > symbols.json
+
+JSON output
+<pre class='prettyprint linenums lang-js'>
+ coddoc -d ./lib > symbols.json
</pre>
-To use the markdown formmater
-<pre>
-coddoc -d ./lib -f markdown > README.md
+
+To use the markdown formatter
+<pre class='prettyprint linenums lang-js'>
+ coddoc -d ./lib -f markdown > README.md
</pre>
-<pre>
+
To use the HTML formatter
-coddoc -d ./lib -f html > index.html
+<pre class='prettyprint linenums lang-js'>
+ coddoc -d ./lib -f html > index.html
</pre>
To use pragmatically
-<pre>
+<pre class='prettyprint linenums lang-js'>
+
var coddoc = require("coddoc");
var tree = coddoc.parse({directory : __dirname + "/lib"});
var classes = tree.classes, namespaces = tree.namespaces;
//do something
+
</pre>
@@ -416,10 +441,10 @@
<li> <em>options.dir</em> <code>String</code> : the directory of code to parse.</li>
- <li> <em>[options.pattern=/.+\.js$/i]</em> <code>RegExp</code> : a regular expression to test files agains</li>
+ <li> <em>[options.pattern= <code>/.+\.js$/i</code>]</em> <code>RegExp</code> : a regular expression to test files agains</li>
<li> <em>options.formatter?</em> <code>Object</code> : And optional formatter to format the tree. The object must contain
-a <code>generate</code> method. See <a href='#coddoc_formatters_html'>coddoc.formatters.html</a></li>
+a <code>generate</code> method. See <a href='#coddoc_formatters_html'> coddoc.formatters.html</a></li>
</ul>
@@ -431,11 +456,10 @@
<pre class="prettyprint linenums lang-js">
function (options){
options = options || {};
- var baseDir = options.dir;
+ var baseDir = options.dir, filePattern = options.pattern || FILE_PATTERN;
if (!baseDir) {
console.log(&quot;directory required&quot;);
}
- var filePattern = options.pattern || FILE_PATTERN;
var fileMap = {};
(function findFiles(dir) {
var files = fs.readdirSync(dir);
@@ -448,18 +472,15 @@
fileMap[filePath] = fs.readFileSync(filePath, &quot;utf8&quot;);
}
});
- })(baseDir);
- var context = new Context();
- var tree = new Tree();
+ }(baseDir));
+ var context = new Context(), tree = new Tree();
Object.keys(fileMap).forEach(function (i, j) {
- context.activateScope(&quot;global&quot;)
- parser.parse(fileMap[i], path.relative(baseDir, i), tree, context);
+ emitter.emit(&quot;file&quot;, i);
+ context.activateScope(&quot;global&quot;);
+ parser.parse(fileMap[i], path.relative(baseDir, i), tree, context, emitter);
});
- var formatter = options.formatter, ret = tree;
- if (formatter &amp;&amp; formatter.generate) {
- ret = formatter.generate(tree);
- }
- return ret;
+ return tree;
+
}
</pre>
@@ -554,10 +575,10 @@
<li> <em>regexp</em> : the regular expression used to match code blocks.</li>
- <li> <em>[priority=0]</em> : the priority to give this code handler if not provided
+ <li> <em>[priority= <code>0</code>]</em> : the priority to give this code handler if not provided
it is defaulted to 0.</li>
- <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>
+ <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>
</ul>
@@ -568,18 +589,19 @@
<em>Source</em>
<pre class="prettyprint linenums lang-js">
function (regexp,priority,parse){
- if(util.isFunction(priority)){
- parse = priority
+ if (util.isFunction(priority)) {
+ parse = priority;
priority = 0;
}
handlers.push({
- priority : priority,
+ priority:priority,
match:function (str) {
return regexp.exec(str);
},
parse:parse
});
handlers.sort(sortHandlers);
+
}
</pre>
@@ -606,7 +628,7 @@
<em>Defined parser/tags.js</em>
<p>
-Adds a new tag to be parsed. You can use this to add custom tags. <a href='#coddoc'>coddoc</a> will
+Adds a new tag to be parsed. You can use this to add custom tags. <a href='#coddoc'> coddoc</a> will
not do anything with the new tag by default, however you can add functionality to handle the
new tag in the template.
@@ -668,6 +690,7 @@
return {tag:tag, props:{}};
}};
});
+
}
</pre>
@@ -714,6 +737,7 @@
<pre class="prettyprint linenums lang-js">
function (){
return new RegExp(&quot;@(&quot; + Object.keys(tags).join(&quot;|&quot;) + &quot;)&quot;);
+
}
</pre>
@@ -740,7 +764,7 @@
<em>Defined parser/index.js</em>
<p>
-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>.
+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>.
This method is not intended to be used directly by user code.
</p>
@@ -757,6 +781,8 @@
<li> <em>context</em> : the context which holds information about the current parsing job.</li>
+ <li> <em>emitter</em> : </li>
+
</ul>
@@ -772,26 +798,26 @@
<em>Source</em>
<pre class="prettyprint linenums lang-js">
-function (str,filepath,tree,context){
+function (str,filepath,tree,context,emitter){
var l = str.length;
var symbols = [];
for (var i = 0; i &lt; l; i++) {
var tags = [];
var comment = &quot;&quot;, c = str[i], startIndex = i, endIndex, ret = [];
var startCIndex = str.indexOf(&quot;/**&quot;, i);
- if (startCIndex != -1) {
+ if (startCIndex !== -1) {
i = startCIndex + 2;
var endCIndex = str.indexOf(&quot;*/&quot;, i);
- if (endCIndex != -1) {
- comment = str.substr(startCIndex + 2, endCIndex - (startCIndex + 2)).split(&quot;\n&quot;).map(
- function (str) {
- return str.replace(/^\s*\*\s?/, &quot;&quot;)
- }).join(&quot;\n&quot;);
+ if (endCIndex !== -1) {
+ comment = str.substr(startCIndex + 2, endCIndex - (startCIndex + 2)).split(&quot;\n&quot;).map(joinAndReplace).join(&quot;\n&quot;);
+ emitter.emit(&quot;comment&quot;, comment);
i = endCIndex + 1;
//console.log(str.substr(startCIndex, endCIndex - startCIndex));
//console.log(comment);
- var sym = parseTags({comment:comment, start:startCIndex, end:endCIndex + 2}, str, filepath, context);
+ var res = parseTags({comment:comment, start:startCIndex, end:endCIndex + 2}, str, filepath, context),
+ sym = res.symbol;
symbols.push(sym);
+ emitter.emit(&quot;symbol&quot;, sym);
var memberof = sym.memberof;
if (!sym.ignore &amp;&amp; !sym.lends) {
tree.addSymbol(sym);
@@ -802,6 +828,7 @@
}
}
return {symbols:symbols, code:str};
+
}
</pre>
@@ -829,7 +856,7 @@
<p>
Uses Registered handlers to parse the next block of code from a code fragment. This function is
-used by <a href='#coddoc_parse'>coddoc.parse</a> to parse code for comments.
+used by <a href='#coddoc_parse'> coddoc.parse</a> to parse code for comments.
</p>
@@ -860,10 +887,13 @@
break;
}
}
- symbol.codeObject = ret;
- for (var i in ret) {
- symbol[i] = ret[i];
+ if (ret) {
+ symbol.codeObject = ret;
+ Object.keys(ret).forEach(function (i) {
+ symbol[i] = ret[i];
+ });
}
+
}
</pre>
@@ -891,8 +921,8 @@
<p>
Parses a tag and the coresponding comment using a matching tag handler. Each parsed tag
-could add a new property to the <a href='#coddoc_Symbol'>coddoc.Symbol</a>. The parsed tag will be added the the
-<a href='#coddoc_Symbol_prototype_tags'>coddoc.Symbol#tags</a> array.
+could add a new property to the <a href='#coddoc_Symbol'> coddoc.Symbol</a>. The parsed tag will be added the the
+<a href='#coddoc_Symbol_prototype_tags'> coddoc.Symbol#tags</a> array.
</p>
@@ -912,14 +942,14 @@
<em>Arguments</em>
<ul>
- <li> <em>tag</em> : the tag name being parsed from the comment</li>
-
<li> <em>comment</em> : the comment fragment being parsed</li>
<li> <em>sym</em> : the symbol that the comment corresponds to. The code object and values will have already been set.</li>
<li> <em>context</em> : the currect context object. The context allows tags to set new scopes and namespaces.</li>
+ <li> <em>tag</em> <code>String</code> : the tag name being parsed from the comment</li>
+
</ul>
@@ -928,13 +958,17 @@
<em>Source</em>
<pre class="prettyprint linenums lang-js">
-function (tag,comment,sym,context){
- var t = tags[tag];
- if (t) {
- t.parse(comment, sym, context)
- } else {
- throw new Error(&quot;Invalid tag &quot; + tag);
+function (comment,sym,context){
+ var tag = comment.match(TAG_REGEXP), ret = {};
+ if (tag &amp;&amp; tag.length === 2) {
+ var t = tags[tag[1]];
+ if (t) {
+ t.parse(comment, sym, context);
+ } else {
+ throw new Error(&quot;Invalid tag &quot; + tag);
+ }
}
+
}
</pre>
@@ -975,8 +1009,6 @@
<li><a href="#coddoc_Context_prototype_activateScope">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -991,8 +1023,6 @@
<li><a href="#coddoc_Context_prototype_addNamespace">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1007,8 +1037,6 @@
<li><a href="#coddoc_Context_prototype_addScope">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1023,8 +1051,6 @@
<li><a href="#coddoc_Context_prototype_getActiveScope">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1039,8 +1065,6 @@
<li><a href="#coddoc_Context_prototype_getActiveScopeName">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1055,8 +1079,6 @@
<li><a href="#coddoc_Context_prototype_getNamespace">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1071,8 +1093,6 @@
<li><a href="#coddoc_Context_prototype_getScope">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1123,6 +1143,7 @@
this.nameSpaces = {global:[]};
this.aliases = {};
this.activateScope(&quot;global&quot;);
+
}
</pre>
@@ -1134,8 +1155,6 @@
<h3>
activateScope
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1177,6 +1196,7 @@
function (name){
this.activeScope = name;
return this.addScope(name);
+
}
</pre>
@@ -1187,8 +1207,6 @@
<h3>
addNamespace
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1232,6 +1250,7 @@
this.nameSpaces[name] = {};
}
return this.nameSpaces[name];
+
}
</pre>
@@ -1242,8 +1261,6 @@
<h3>
addScope
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1288,6 +1305,7 @@
this.scopes[name] = {};
}
return this.scopes[name];
+
}
</pre>
@@ -1298,8 +1316,6 @@
<h3>
getActiveScope
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1334,6 +1350,7 @@
<pre class="prettyprint linenums lang-js">
function (){
return this.getScope(this.activeScope);
+
}
</pre>
@@ -1344,8 +1361,6 @@
<h3>
getActiveScopeName
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1380,6 +1395,7 @@
<pre class="prettyprint linenums lang-js">
function (){
return this.activeScope;
+
}
</pre>
@@ -1390,8 +1406,6 @@
<h3>
getNamespace
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1433,6 +1447,7 @@
<pre class="prettyprint linenums lang-js">
function (name){
return this.addNamespace(name);
+
}
</pre>
@@ -1443,8 +1458,6 @@
<h3>
getScope
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1486,6 +1499,7 @@
<pre class="prettyprint linenums lang-js">
function (name){
return this.addScope(name);
+
}
</pre>
@@ -1527,9 +1541,9 @@
<p>
-A Symbol represents a comment and code pair. Each code handler added through <a href='#coddoc_addCodeHandler'>coddoc.addCodeHandler</a> and
-tag handler added through <a href='#coddoc_addTagHandler'>coddoc.addTagHandler</a> adds/removes properties from a the symbol. Each symbol is
-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.
+A Symbol represents a comment and code pair. Each code handler added through <a href='#coddoc_addCodeHandler'> coddoc.addCodeHandler</a> and
+tag handler added through <a href='#coddoc_addTagHandler'> coddoc.addTagHandler</a> adds/removes properties from a the symbol. Each symbol is
+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.
<b>NOTE: This object should not be instantiated by user code</b>
@@ -1543,69 +1557,71 @@
<a name="coddoc_Symbol_instanceProperties"></a>
<em>Instance Properties</em>
- <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>
+ <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>
[]
- </code></td><td>
+ </code></td><td>
Any symbols this symbol augments
-</td><tr><tr><td><em>borrows</em></td><td>{Array}</td><td><code>
+</td><tr><tr><td>borrows</td><td>{Array}</td><td><code>
[]
- </code></td><td>
+ </code></td><td>
Any properties this symbol borrows
-</td><tr><tr><td><em>codeObject</em></td><td>{Object}</td><td><code>null</code></td><td>
+</td><tr><tr><td>codeObject</td><td>{Object}</td><td><code>null</code></td><td>
The codeObject of this symbol
-</td><tr><tr><td><em>description</em></td><td>{String}</td><td><code>""</code></td><td>
+</td><tr><tr><td>description</td><td>{String}</td><td><code>""</code></td><td>
The description of this symbol.
-</td><tr><tr><td><em>examples</em></td><td>{Array}</td><td><code>
+</td><tr><tr><td>examples</td><td>{Array}</td><td><code>
[]
- </code></td><td>
+ </code></td><td>
The examples for this symbol
-</td><tr><tr><td><em>file</em></td><td>{String}</td><td><code>""</code></td><td>
+</td><tr><tr><td>file</td><td>{String}</td><td><code>""</code></td><td>
The file where the symbol was found.
-</td><tr><tr><td><em>fullname</em></td><td>{String}</td><td><code>""</code></td><td>
+</td><tr><tr><td>fullname</td><td>{String}</td><td><code>""</code></td><td>
The fullname i.e ({memberof}.{name})
-</td><tr><tr><td><em>ignoreCode</em></td><td>{Boolean}</td><td><code>false</code></td><td>
+</td><tr><tr><td>ignore</td><td>{Boolean}</td><td><code>false</code></td><td>
+Set to true if the symbol should be ignored and not put into <a href='#coddoc_Tree'> coddoc.Tree</a>
+</td><tr><tr><td>ignoreCode</td><td>{Boolean}</td><td><code>false</code></td><td>
Set to true if the code object from this symbol should be ignored.
-</td><tr><tr><td><em>isConstant</em></td><td>{Boolean}</td><td><code>false</code></td><td>
+</td><tr><tr><td>isConstant</td><td>{Boolean}</td><td><code>false</code></td><td>
Set to true if this symbol is a constant.
-</td><tr><tr><td><em>isConstructor</em></td><td>{Boolean}</td><td><code>false</code></td><td>
+</td><tr><tr><td>isConstructor</td><td>{Boolean}</td><td><code>false</code></td><td>
Set to true is this symbol is a constructor
-</td><tr><tr><td><em>isFunction</em></td><td>{Boolean}</td><td><code>false</code></td><td>
+</td><tr><tr><td>isFunction</td><td>{Boolean}</td><td><code>false</code></td><td>
Set to true if this symbol is a function.
-</td><tr><tr><td><em>isPrivate</em></td><td>{Boolean}</td><td><code>false</code></td><td>
+</td><tr><tr><td>isPrivate</td><td>{Boolean}</td><td><code>false</code></td><td>
Set to true if this symbol is private.
-</td><tr><tr><td><em>isProtected</em></td><td>{Boolean}</td><td><code>false</code></td><td>
+</td><tr><tr><td>isProtected</td><td>{Boolean}</td><td><code>false</code></td><td>
Set to true if this symbol is protected.
-</td><tr><tr><td><em>isStatic</em></td><td>{Boolean}</td><td><code>false</code></td><td>
+</td><tr><tr><td>isStatic</td><td>{Boolean}</td><td><code>false</code></td><td>
Set to true if this symbol is static
-</td><tr><tr><td><em>memberof</em></td><td>{String}</td><td><code>""</code></td><td>
+</td><tr><tr><td>memberof</td><td>{String}</td><td><code>""</code></td><td>
Who this symbol belongs to.
-</td><tr><tr><td><em>name</em></td><td>{String}</td><td><code>""</code></td><td>
+</td><tr><tr><td>name</td><td>{String}</td><td><code>""</code></td><td>
The name of this symbol
-</td><tr><tr><td><em>params</em></td><td>{Array}</td><td><code>
+</td><tr><tr><td>params</td><td>{Array}</td><td><code>
[]
- </code></td><td>
+ </code></td><td>
The associated params for this symbol if it is a funciton.
-</td><tr><tr><td><em>properties</em></td><td>{Array}</td><td><code>
+</td><tr><tr><td>properties</td><td>{Array}</td><td><code>
[]
- </code></td><td>
+ </code></td><td>
The associated properties for this symbol
-</td><tr><tr><td><em>returns</em></td><td>{Array}</td><td><code>
+</td><tr><tr><td>returns</td><td>{Array}</td><td><code>
[]
- </code></td><td>
+ </code></td><td>
Array of return types for this symbol
-</td><tr><tr><td><em>see</em></td><td>{Array}</td><td><code>
+</td><tr><tr><td>see</td><td>{Array}</td><td><code>
[]
- </code></td><td>
+ </code></td><td>
Any link for this symbol
-</td><tr><tr><td><em>tags</em></td><td>{Array}</td><td><code>
+</td><tr><tr><td>tags</td><td>{Array}</td><td><code>
[]
- </code></td><td>
+ </code></td><td>
The associated tags for this symbol
-</td><tr><tr><td><em>throws</em></td><td>{Array}</td><td><code>
+</td><tr><tr><td>throws</td><td>{Array}</td><td><code>
[]
- </code></td><td>
+ </code></td><td>
Exceptions thrown by this symbol
-</td><tr><tr><td><em>type</em></td><td>{*}</td><td><code>null</code></td><td>
+</td><tr><tr><td>type</td><td>{*}</td><td><code>null</code></td><td>
The type that is symbol represents.
</td><tr></table>
@@ -1634,13 +1650,17 @@
this.examples = [];
this.borrows = [];
this.augments = [];
+ this.includedDocs = [];
this.see = [];
this.throws = [];
this.returns = [];
options = options || {};
for (var i in options) {
- this[i] = options[i];
+ if (i in this) {
+ this[i] = options[i];
+ }
}
+
}
</pre>
@@ -1678,8 +1698,6 @@
<li><a href="#coddoc_Tree_prototype__addSymbol">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1692,8 +1710,6 @@
<li><a href="#coddoc_Tree_prototype_addSymbol">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1708,8 +1724,6 @@
<li><a href="#coddoc_Tree_prototype_getClasses">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1724,8 +1738,6 @@
<li><a href="#coddoc_Tree_prototype_getMembers">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1740,8 +1752,6 @@
<li><a href="#coddoc_Tree_prototype_getNamespaces">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1756,8 +1766,6 @@
<li><a href="#coddoc_Tree_prototype_getSymbol">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1772,8 +1780,6 @@
<li><a href="#coddoc_Tree_prototype_hasSymbol">
- <span class="label label-info">S</span>
-
<span class="label label-label">F</span>
@@ -1820,6 +1826,7 @@
<pre class="prettyprint linenums lang-js">
function (){
this.symbols = {global:[]};
+
}
</pre>
@@ -1831,8 +1838,6 @@
<h3>
_addSymbol
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1875,6 +1880,7 @@
ret = this.symbols[name] = [];
}
return ret;
+
}
</pre>
@@ -1885,8 +1891,6 @@
<h3>
addSymbol
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1925,10 +1929,14 @@
<em>Source</em>
<pre class="prettyprint linenums lang-js">
function (symbol){
- var path = symbol.memberof, name = symbol.name;
- path == &quot;global&quot; &amp;&amp; (path = name);
+ var nameParts = utils.splitName(symbol.fullName);
+ var path = nameParts.memberof, name = nameParts.name;
+ if (path === &quot;global&quot;) {
+ path = name;
+ }
var sym = this.getSymbol(path);
sym.push(symbol);
+
}
</pre>
@@ -1939,8 +1947,6 @@
<h3>
getClasses
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -1993,7 +1999,7 @@
var name = s.fullName;
var statics = symbols[name] || [];
var instance = symbols[name + &quot;.prototype&quot;] || [];
- var borrowedMethods = [], borrowedProperties = [], staticBorrowedMethods = [], staticBorrowedProperties = []
+ var borrowedMethods = [], borrowedProperties = [], staticBorrowedMethods = [], staticBorrowedProperties = [];
s.borrows.map(function (b) {
var borrows = b.borrows;
var symbol = symbols[borrows.memberof || &quot;global&quot;].filter(function (s) {
@@ -2026,7 +2032,6 @@
s.staticProperties = statics.filter(
function (s) {
return !s.isFunction &amp;&amp; !s.isNamespace;
- ;
}).concat(staticBorrowedProperties);
s.instanceMethods = instance.filter(
function (s) {
@@ -2038,6 +2043,7 @@
}).concat(s.properties || []).concat(borrowedProperties);
return s;
});
+
}
</pre>
@@ -2048,8 +2054,6 @@
<h3>
getMembers
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -2064,7 +2068,7 @@
<em>Defined tree.js</em>
<p>
-Gets all members(<a href='#coddoc_Symbol'>coddoc.Symbol</a>) for a particular path.
+Gets all members(<a href='#coddoc_Symbol'> coddoc.Symbol</a>) for a particular path.
</p>
@@ -2098,6 +2102,7 @@
}));
});
return namespaces;
+
}
</pre>
@@ -2108,8 +2113,6 @@
<h3>
getNamespaces
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -2157,17 +2160,18 @@
}));
});
return namespaces.map(function (s) {
- var realName = s.memberof &amp;&amp; s.memberof != &quot;global&quot; ? [s.memberof, s.name].join(&quot;.&quot;) : s.name;
+ var realName = s.memberof &amp;&amp; s.memberof !== &quot;global&quot; ? [s.memberof, s.name].join(&quot;.&quot;) : s.name;
var members = this.getMembers(realName);
s.name = realName;
- s.properties = members.filter(function (m) {
+ s.properties = s.properties.concat(members.filter(function (m) {
return !m.isFunction;
- });
+ }));
s.methods = members.filter(function (m) {
return m.isFunction;
});
return s;
}, this);
+
}
</pre>
@@ -2178,8 +2182,6 @@
<h3>
getSymbol
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -2221,6 +2223,7 @@
<pre class="prettyprint linenums lang-js">
function (name){
return this._addSymbol(name);
+
}
</pre>
@@ -2231,8 +2234,6 @@
<h3>
hasSymbol
- <span class="label label-info">Static</span>
-
<span class="label label-label">Function</span>
@@ -2275,6 +2276,7 @@
function (name){
var parts = name.split(&quot;.&quot;);
return !!this.symbols[name];
+
}
</pre>
@@ -2285,11 +2287,11 @@
<h2>License</h2>
-<p>MIT <a href = https://github.com/Pollenware/downdoc/raw/master/LICENSE>LICENSE</a><p>
+<p>MIT <a href = https://github.com/Pollenware/coddoc/raw/master/LICENSE>LICENSE</a><p>
<h2>Meta</h2>
<hr>
-<p>Code: <code>git clone git://github.com/pollenware/downdoc.git</code></br></p>
+<p>Code: <code>git clone git://github.com/pollenware/coddoc.git</code></br></p>
</div>
</div>
View
77 README.md
@@ -6,7 +6,7 @@
<h2> Description</h2>
<p>
coddoc is a jsdoc parsing library. Coddoc is different in that it is easily extensible by allowing users to
- add tag and code parsers through the use of <a href='# coddoc_addTagHandler'> coddoc.addTagHandler</a> and <a href='# coddoc_addCodeHandler'> coddoc.addCodeHandler</a>.
+ add tag and code parsers through the use of <a href='#coddoc_addTagHandler'> coddoc.addTagHandler</a> and <a href='#coddoc_addCodeHandler'> coddoc.addCodeHandler</a>.
coddoc also parses source code to be used in APIs.
</p>
@@ -161,7 +161,7 @@ Entry point for parsing code.
---
-*Defined * [Top](#top)
+*Defined parser/code.js* [Top](#top)
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
* _[priority=0]_ : the priority to give this code handler if not provided
it is defaulted to 0.
- * _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.
+ * _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.
@@ -271,10 +271,10 @@ function (regexp,priority,parse){
---
-*Defined * [Top](#top)
+*Defined parser/tags.js* [Top](#top)
-Adds a new tag to be parsed. You can use this to add custom tags. <a href='# coddoc'> coddoc</a> will
+Adds a new tag to be parsed. You can use this to add custom tags. <a href='#coddoc'> coddoc</a> will
not do anything with the new tag by default, however you can add functionality to handle the
new tag in the template.
@@ -349,7 +349,7 @@ function (tag,parse){
---
-*Defined * [Top](#top)
+*Defined parser/tags.js* [Top](#top)
Returns a regular expression that can be used to parse tags
@@ -383,10 +383,10 @@ function (){
---
-*Defined * [Top](#top)
+*Defined parser/index.js* [Top](#top)
-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>.
+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>.
This method is not intended to be used directly by user code.
@@ -460,11 +460,11 @@ function (str,filepath,tree,context,emitter){
---
-*Defined * [Top](#top)
+*Defined parser/code.js* [Top](#top)
Uses Registered handlers to parse the next block of code from a code fragment. This function is
-used by <a href='# coddoc_parse'> coddoc.parse</a> to parse code for comments.
+used by <a href='#coddoc_parse'> coddoc.parse</a> to parse code for comments.
@@ -513,12 +513,12 @@ function (str,symbol,context){
---
-*Defined * [Top](#top)
+*Defined parser/tags.js* [Top](#top)
Parses a tag and the coresponding comment using a matching tag handler. Each parsed tag
-could add a new property to the <a href='# coddoc_Symbol'> coddoc.Symbol</a>. The parsed tag will be added the the
-<a href='# coddoc_Symbol_prototype_tags'> coddoc.Symbol#tags</a> array.
+could add a new property to the <a href='#coddoc_Symbol'> coddoc.Symbol</a>. The parsed tag will be added the the
+<a href='#coddoc_Symbol_prototype_tags'> coddoc.Symbol#tags</a> array.
@@ -614,7 +614,7 @@ The context should not be used directly by user code.
###Constructor
-*Defined * [Top](#top)
+*Defined context.js* [Top](#top)
@@ -641,7 +641,7 @@ function (){
---
-*Defined * [Top](#top)
+*Defined context.js* [Top](#top)
Activates a scope for.
@@ -681,7 +681,7 @@ function (name){
---
-*Defined * [Top](#top)
+*Defined context.js* [Top](#top)
Adds a namespace the the context object.
@@ -723,7 +723,7 @@ function (name){
---
-*Defined * [Top](#top)
+*Defined context.js* [Top](#top)
Adds a scope to the context
@@ -766,7 +766,7 @@ function (name){
---
-*Defined * [Top](#top)
+*Defined context.js* [Top](#top)
Returns the active scope.
@@ -800,7 +800,7 @@ function (){
---
-*Defined * [Top](#top)
+*Defined context.js* [Top](#top)
Returns the name of the active scope.
@@ -834,7 +834,7 @@ function (){
---
-*Defined * [Top](#top)
+*Defined context.js* [Top](#top)
Gets a namespace, creating it if it does not exist.
@@ -874,7 +874,7 @@ function (name){
---
-*Defined * [Top](#top)
+*Defined context.js* [Top](#top)
Gets a scope creating it if it does not exist.
@@ -915,9 +915,9 @@ function (name){
[Top](#top)
-A Symbol represents a comment and code pair. Each code handler added through <a href='# coddoc_addCodeHandler'> coddoc.addCodeHandler</a> and
-tag handler added through <a href='# coddoc_addTagHandler'> coddoc.addTagHandler</a> adds/removes properties from a the symbol. Each symbol is
-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.
+A Symbol represents a comment and code pair. Each code handler added through <a href='#coddoc_addCodeHandler'> coddoc.addCodeHandler</a> and
+tag handler added through <a href='#coddoc_addTagHandler'> coddoc.addTagHandler</a> adds/removes properties from a the symbol. Each symbol is
+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.
<b>NOTE: This object should not be instantiated by user code</b>
@@ -952,7 +952,7 @@ The file where the symbol was found.
</td><tr><tr><td>fullname</td><td>{String}</td><td><code>""</code></td><td>
The fullname i.e ({memberof}.{name})
</td><tr><tr><td>ignore</td><td>{Boolean}</td><td><code>false</code></td><td>
-Set to true if the symbol should be ignored and not put into <a href='# coddoc_Tree'> coddoc.Tree</a>
+Set to true if the symbol should be ignored and not put into <a href='#coddoc_Tree'> coddoc.Tree</a>
</td><tr><tr><td>ignoreCode</td><td>{Boolean}</td><td><code>false</code></td><td>
Set to true if the code object from this symbol should be ignored.
</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.
###Constructor
-*Defined * [Top](#top)
+*Defined symbol.js* [Top](#top)
*Arguments*
@@ -1026,12 +1026,13 @@ function (options){
this.examples = [];
this.borrows = [];
this.augments = [];
+ this.includedDocs = [];
this.see = [];
this.throws = [];
this.returns = [];
options = options || {};
for (var i in options) {
- if (this.hasOwnProperty(i)) {
+ if (i in this) {
this[i] = options[i];
}
}
@@ -1083,7 +1084,7 @@ A Tree object which contains symbols.
###Constructor
-*Defined * [Top](#top)
+*Defined tree.js* [Top](#top)
@@ -1107,7 +1108,7 @@ function (){
---
-*Defined * [Top](#top)
+*Defined tree.js* [Top](#top)
Adds a symbol to this tree.
@@ -1150,7 +1151,7 @@ function (name){
---
-*Defined * [Top](#top)
+*Defined tree.js* [Top](#top)
Entry point to add the symbol
@@ -1196,7 +1197,7 @@ function (symbol){
---
-*Defined * [Top](#top)
+*Defined tree.js* [Top](#top)
Returns all classes in the tree. The following properties are added to each class symbol.
@@ -1292,10 +1293,10 @@ function (){
---
-*Defined * [Top](#top)
+*Defined tree.js* [Top](#top)
-Gets all members(<a href='# coddoc_Symbol'> coddoc.Symbol</a>) for a particular path.
+Gets all members(<a href='#coddoc_Symbol'> coddoc.Symbol</a>) for a particular path.
@@ -1339,7 +1340,7 @@ function (path){
---
-*Defined * [Top](#top)
+*Defined tree.js* [Top](#top)
Returns all namespaces in this tree. This method also adds the following values to the namespace.
@@ -1397,7 +1398,7 @@ function (){
---
-*Defined * [Top](#top)
+*Defined tree.js* [Top](#top)
Returns a symbol from this tree. The Tree will create the symbol if it does not exist.
@@ -1437,7 +1438,7 @@ function (name){
---
-*Defined * [Top](#top)
+*Defined tree.js* [Top](#top)
Returns true if this tree contains a symbol.
@@ -1476,11 +1477,11 @@ function (name){
<h2>License</h2>
-<p>MIT <a href = https://github.com/Pollenware/downdoc/raw/master/LICENSE>LICENSE</a><p>
+<p>MIT <a href = https://github.com/Pollenware/coddoc/raw/master/LICENSE>LICENSE</a><p>
<h2>Meta</h2>
<hr>
-<p>Code: <code>git clone git://github.com/pollenware/downdoc.git</code></br></p>
+<p>Code: <code>git clone git://github.com/pollenware/coddoc.git</code></br></p>
View
7 bin/coddoc
@@ -16,7 +16,7 @@
.option('-f, --formatter <path>', 'Use built in formatter')
.option('-p, --pattern <string>', 'file pattern to use')
.on("formatters", function () {
- console.log(["", "Reporters:", "\tmarkdown", "\thtml", ""].join("\n"));
+ console.log(["", "Reporters:", "\tmarkdown", "\thtml", "\tmulti-html", ""].join("\n"));
process.exit();
})
.parse(process.argv);
@@ -47,7 +47,10 @@
if (tree) {
if (formatter) {
if (formatter && formatter.generate) {
- console.log(formatter.generate(tree, program));
+ var result = formatter.generate(tree, program);
+ if(result){
+ console.log(result);
+ }
}
} else {
console.log(JSON.stringify(tree, null, 2));
View
808 docs/assets/css/bootstrap-responsive.css
@@ -0,0 +1,808 @@
+/*!
+ * Bootstrap Responsive v2.0.3
+ *
+ * Copyright 2012 Twitter, Inc
+ * Licensed under the Apache License v2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Designed and built with all the love in the world @twitter by @mdo and @fat.
+ */
+
+.clearfix {
+ *zoom: 1;
+}
+
+.clearfix:before,
+.clearfix:after {
+ display: table;
+ content: "";
+}
+
+.clearfix:after {
+ clear: both;
+}
+
+.hide-text {
+ font: 0/0 a;
+ color: transparent;
+ text-shadow: none;
+ background-color: transparent;
+ border: 0;
+}
+
+.input-block-level {
+ display: block;
+ width: 100%;
+ min-height: 28px;
+ -webkit-box-sizing: border-box;
+ -moz-box-sizing: border-box;
+ -ms-box-sizing: border-box;
+ box-sizing: border-box;
+}
+
+.hidden {
+ display: none;
+ visibility: hidden;
+}
+
+.visible-phone {
+ display: none !important;
+}
+
+.visible-tablet {
+ display: none !important;
+}
+
+.hidden-desktop {
+ display: none !important;
+}
+
+@media (max-width: 767px) {
+ .visible-phone {
+ display: inherit !important;
+ }
+ .hidden-phone {
+ display: none !important;
+ }
+ .hidden-desktop {
+ display: inherit !important;
+ }
+ .visible-desktop {
+ display: none !important;
+ }
+}
+
+@media (min-width: 768px) and (max-width: 979px) {
+ .visible-tablet {
+ display: inherit !important;
+ }
+ .hidden-tablet {
+ display: none !important;
+ }
+ .hidden-desktop {
+ display: inherit !important;
+ }
+ .visible-desktop {
+ display: none !important ;
+ }
+}
+
+@media (max-width: 480px) {
+ .nav-collapse {
+ -webkit-transform: translate3d(0, 0, 0);
+ }
+ .page-header h1 small {
+ display: block;
+ line-height: 18px;
+ }
+ input[type="checkbox"],
+ input[type="radio"] {
+ border: 1px solid #ccc;
+ }
+ .form-horizontal .control-group > label {
+ float: none;
+ width: auto;
+ padding-top: 0;
+ text-align: left;
+ }
+ .form-horizontal .controls {
+ margin-left: 0;
+ }
+ .form-horizontal .control-list {
+ padding-top: 0;
+ }
+ .form-horizontal .form-actions {
+ padding-right: 10px;
+ padding-left: 10px;
+ }
+ .modal {
+ position: absolute;
+ top: 10px;
+ right: 10px;
+ left: 10px;
+ width: auto;
+ margin: 0;
+ }
+ .modal.fade.in {
+ top: auto;
+ }
+ .modal-header .close {
+ padding: 10px;
+ margin: -10px;
+ }
+ .carousel-caption {
+ position: static;
+ }
+}
+
+@media (max-width: 767px) {
+ body {
+ padding-right: 20px;
+ padding-left: 20px;
+ }
+ .navbar-fixed-top,
+ .navbar-fixed-bottom {
+ margin-right: -20px;
+ margin-left: -20px;
+ }
+ .container-fluid {
+ padding: 0;
+ }
+ .dl-horizontal dt {
+ float: none;
+ width: auto;
+ clear: none;
+ text-align: left;
+ }
+ .dl-horizontal dd {
+ margin-left: 0;
+ }
+ .container {
+ width: auto;
+ }
+ .row-fluid {
+ width: 100%;
+ }
+ .row,
+ .thumbnails {
+ margin-left: 0;
+ }
+ [class*="span"],
+ .row-fluid [class*="span"] {
+ display: block;
+ float: none;
+ width: auto;
+ margin-left: 0;
+ }
+ .input-large,
+ .input-xlarge,
+ .input-xxlarge,
+ input[class*="span"],
+ select[class*="span"],
+ textarea[class*="span"],
+ .uneditable-input {
+ display: block;
+ width: 100%;
+ min-height: 28px;
+ -webkit-box-sizing: border-box;
+ -moz-box-sizing: border-box;
+ -ms-box-sizing: border-box;
+ box-sizing: border-box;
+ }
+ .input-prepend input,
+ .input-append input,
+ .input-prepend input[class*="span"],
+ .input-append input[class*="span"] {
+ display: inline-block;
+ width: auto;
+ }
+}
+
+@media (min-width: 768px) and (max-width: 979px) {
+ .row {
+ margin-left: -20px;
+ *zoom: 1;
+ }
+ .row:before,
+ .row:after {
+ display: table;
+ content: "";
+ }
+ .row:after {
+ clear: both;
+ }
+ [class*="span"] {
+ float: left;
+ margin-left: 20px;
+ }
+ .container,
+ .navbar-fixed-top .container,
+ .navbar-fixed-bottom .container {
+ width: 724px;
+ }
+ .span12 {
+ width: 724px;
+ }
+ .span11 {
+ width: 662px;
+ }
+ .span10 {
+ width: 600px;
+ }
+ .span9 {
+ width: 538px;
+ }
+ .span8 {
+ width: 476px;
+ }
+ .span7 {
+ width: 414px;
+ }
+ .span6 {
+ width: 352px;
+ }
+ .span5 {
+ width: 290px;
+ }
+ .span4 {
+ width: 228px;
+ }
+ .span3 {
+ width: 166px;
+ }
+ .span2 {
+ width: 104px;
+ }
+ .span1 {
+ width: 42px;
+ }
+ .offset12 {
+ margin-left: 764px;
+ }
+ .offset11 {
+ margin-left: 702px;
+ }
+ .offset10 {
+ margin-left: 640px;
+ }
+ .offset9 {
+ margin-left: 578px;
+ }
+ .offset8 {
+ margin-left: 516px;
+ }
+ .offset7 {
+ margin-left: 454px;
+ }
+ .offset6 {
+ margin-left: 392px;
+ }
+ .offset5 {
+ margin-left: 330px;
+ }
+ .offset4 {
+ margin-left: 268px;
+ }
+ .offset3 {
+ margin-left: 206px;
+ }
+ .offset2 {
+ margin-left: 144px;
+ }
+ .offset1 {
+ margin-left: 82px;
+ }
+ .row-fluid {
+ width: 100%;
+ *zoom: 1;
+ }
+ .row-fluid:before,
+ .row-fluid:after {
+ display: table;
+ content: "";
+ }
+ .row-fluid:after {
+ clear: both;
+ }
+ .row-fluid [class*="span"] {
+ display: block;
+ float: left;
+ width: 100%;
+ min-height: 28px;
+ margin-left: 2.762430939%;
+ *margin-left: 2.709239449638298%;
+ -webkit-box-sizing: border-box;
+ -moz-box-sizing: border-box;
+ -ms-box-sizing: border-box;
+ box-sizing: border-box;
+ }
+ .row-fluid [class*="span"]:first-child {
+ margin-left: 0;
+ }
+ .row-fluid .span12 {
+ width: 99.999999993%;
+ *width: 99.9468085036383%;
+ }
+ .row-fluid .span11 {
+ width: 91.436464082%;
+ *width: 91.38327259263829%;
+ }
+ .row-fluid .span10 {
+ width: 82.87292817100001%;
+ *width: 82.8197366816383%;
+ }
+ .row-fluid .span9 {
+ width: 74.30939226%;
+ *width: 74.25620077063829%;
+ }
+ .row-fluid .span8 {
+ width: 65.74585634900001%;
+ *width: 65.6926648596383%;
+ }
+ .row-fluid .span7 {
+ width: 57.182320438000005%;
+ *width: 57.129128948638304%;
+ }
+ .row-fluid .span6 {
+ width: 48.618784527%;
+ *width: 48.5655930376383%;
+ }
+ .row-fluid .span5 {
+ width: 40.055248616%;
+ *width: 40.0020571266383%;
+ }
+ .row-fluid .span4 {
+ width: 31.491712705%;
+ *width: 31.4385212156383%;
+ }
+ .row-fluid .span3 {
+ width: 22.928176794%;
+ *width: 22.874985304638297%;
+ }
+ .row-fluid .span2 {
+ width: 14.364640883%;
+ *width: 14.311449393638298%;
+ }
+ .row-fluid .span1 {
+ width: 5.801104972%;
+ *width: 5.747913482638298%;
+ }
+ input,
+ textarea,
+ .uneditable-input {
+ margin-left: 0;
+ }
+ input.span12,
+ textarea.span12,
+ .uneditable-input.span12 {
+ width: 714px;
+ }
+ input.span11,
+ textarea.span11,
+ .uneditable-input.span11 {
+ width: 652px;
+ }
+ input.span10,
+ textarea.span10,
+ .uneditable-input.span10 {
+ width: 590px;
+ }
+ input.span9,
+ textarea.span9,
+ .uneditable-input.span9 {
+ width: 528px;
+ }
+ input.span8,
+ textarea.span8,
+ .uneditable-input.span8 {
+ width: 466px;
+ }
+ input.span7,
+ textarea.span7,
+ .uneditable-input.span7 {
+ width: 404px;
+ }
+ input.span6,
+ textarea.span6,
+ .uneditable-input.span6 {
+ width: 342px;
+ }
+ input.span5,
+ textarea.span5,
+ .uneditable-input.span5 {
+ width: 280px;
+ }
+ input.span4,
+ textarea.span4,
+ .uneditable-input.span4 {
+ width: 218px;
+ }
+ input.span3,
+ textarea.span3,
+ .uneditable-input.span3 {
+ width: 156px;
+ }
+ input.span2,
+ textarea.span2,
+ .uneditable-input.span2 {
+ width: 94px;
+ }
+ input.span1,
+ textarea.span1,
+ .uneditable-input.span1 {
+ width: 32px;
+ }
+}
+
+@media (min-width: 1200px) {
+ .row {
+ margin-left: -30px;
+ *zoom: 1;
+ }
+ .row:before,
+ .row:after {
+ display: table;
+ content: "";
+ }
+ .row:after {
+ clear: both;
+ }
+ [class*="span"] {
+ float: left;
+ margin-left: 30px;
+ }
+ .container,
+ .navbar-fixed-top .container,
+ .navbar-fixed-bottom .container {
+ width: 1170px;
+ }
+ .span12 {
+ width: 1170px;
+ }
+ .span11 {
+ width: 1070px;
+ }
+ .span10 {
+ width: 970px;
+ }
+ .span9 {
+ width: 870px;
+ }
+ .span8 {
+ width: 770px;
+ }
+ .span7 {
+ width: 670px;
+ }
+ .span6 {
+ width: 570px;
+ }
+ .span5 {
+ width: 470px;
+ }
+ .span4 {
+ width: 370px;
+ }
+ .span3 {
+ width: 270px;
+ }
+ .span2 {
+ width: 170px;
+ }
+ .span1 {
+ width: 70px;
+ }
+ .offset12 {
+ margin-left: 1230px;
+ }
+ .offset11 {
+ margin-left: 1130px;
+ }
+ .offset10 {
+ margin-left: 1030px;
+ }
+ .offset9 {
+ margin-left: 930px;
+ }
+ .offset8 {
+ margin-left: 830px;
+ }
+ .offset7 {
+ margin-left: 730px;
+ }
+ .offset6 {
+ margin-left: 630px;
+ }
+ .offset5 {
+ margin-left: 530px;
+ }
+ .offset4 {
+ margin-left: 430px;
+ }
+ .offset3 {
+ margin-left: 330px;
+ }
+ .offset2 {
+ margin-left: 230px;
+ }
+ .offset1 {
+ margin-left: 130px;
+ }
+ .row-fluid {
+ width: 100%;
+ *zoom: 1;
+ }
+ .row-fluid:before,
+ .row-fluid:after {
+ display: table;
+ content: "";
+ }
+ .row-fluid:after {
+ clear: both;
+ }
+ .row-fluid [class*="span"] {
+ display: block;
+ float: left;
+ width: 100%;
+ min-height: 28px;
+ margin-left: 2.564102564%;
+ *margin-left: 2.510911074638298%;
+ -webkit-box-sizing: border-box;
+ -moz-box-sizing: border-box;
+ -ms-box-sizing: border-box;
+ box-sizing: border-box;
+ }
+ .row-fluid [class*="span"]:first-child {
+ margin-left: 0;
+ }
+ .row-fluid .span12 {
+ width: 100%;
+ *width: 99.94680851063829%;
+ }
+ .row-fluid .span11 {
+ width: 91.45299145300001%;
+ *width: 91.3997999636383%;
+ }
+ .row-fluid .span10 {
+ width: 82.905982906%;
+ *width: 82.8527914166383%;
+ }
+ .row-fluid .span9 {
+ width: 74.358974359%;
+ *width: 74.30578286963829%;
+ }
+ .row-fluid .span8 {
+ width: 65.81196581200001%;
+ *width: 65.7587743226383%;
+ }
+ .row-fluid .span7 {
+ width: 57.264957265%;
+ *width: 57.2117657756383%;
+ }
+ .row-fluid .span6 {
+ width: 48.717948718%;
+ *width: 48.6647572286383%;
+ }
+ .row-fluid .span5 {
+ width: 40.170940171000005%;
+ *width: 40.117748681638304%;
+ }
+ .row-fluid .span4 {
+ width: 31.623931624%;
+ *width: 31.5707401346383%;
+ }
+ .row-fluid .span3 {
+ width: 23.076923077%;
+ *width: 23.0237315876383%;
+ }
+ .row-fluid .span2 {
+ width: 14.529914530000001%;
+ *width: 14.4767230406383%;
+ }
+ .row-fluid .span1 {
+ width: 5.982905983%;
+ *width: 5.929714493638298%;
+ }
+ input,
+ textarea,
+ .uneditable-input {
+ margin-left: 0;
+ }
+ input.span12,
+ textarea.span12,
+ .uneditable-input.span12 {
+ width: 1160px;
+ }
+ input.span11,
+ textarea.span11,
+ .uneditable-input.span11 {
+ width: 1060px;
+ }
+ input.span10,
+ textarea.span10,
+ .uneditable-input.span10 {
+ width: 960px;
+ }
+ input.span9,
+ textarea.span9,
+ .uneditable-input.span9 {
+ width: 860px;
+ }
+ input.span8,
+ textarea.span8,
+ .uneditable-input.span8 {
+ width: 760px;
+ }
+ input.span7,
+ textarea.span7,
+ .uneditable-input.span7 {
+ width: 660px;
+ }
+ input.span6,
+ textarea.span6,
+ .uneditable-input.span6 {
+ width: 560px;
+ }
+ input.span5,
+ textarea.span5,
+ .uneditable-input.span5 {
+ width: 460px;
+ }
+ input.span4,
+ textarea.span4,
+ .uneditable-input.span4 {
+ width: 360px;
+ }
+ input.span3,
+ textarea.span3,
+ .uneditable-input.span3 {
+ width: 260px;
+ }
+ input.span2,
+ textarea.span2,
+ .uneditable-input.span2 {
+ width: 160px;
+ }
+ input.span1,
+ textarea.span1,
+ .uneditable-input.span1 {
+ width: 60px;
+ }
+ .thumbnails {
+ margin-left: -30px;
+ }
+ .thumbnails > li {
+ margin-left: 30px;
+ }
+ .row-fluid .thumbnails {
+ margin-left: 0;
+ }
+}
+
+@media (max-width: 979px) {
+ body {
+ padding-top: 0;
+ }
+ .navbar-fixed-top {
+ position: static;
+ margin-bottom: 18px;
+ }
+ .navbar-fixed-top .navbar-inner {
+ padding: 5px;
+ }
+ .navbar .container {
+ width: auto;
+ padding: 0;
+ }
+ .navbar .brand {
+ padding-right: 10px;
+ padding-left: 10px;