Skip to content
This repository
Browse code

Deploy Docs

  • Loading branch information...
commit 0c09371d57f0a397d53fb7e9a61fa3eff0732700 1 parent 6b72d8b
Dav Glass authored May 17, 2012
2  api/classes/CLI.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
26  api/classes/DocBuilder.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
@@ -1153,7 +1153,7 @@ <h3 class="name"><code>compile</code></h3>
1153 1153
             
1154 1154
         
1155 1155
         
1156  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1459"><code>lib&#x2F;builder.js:1459</code></a>
  1156
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1482"><code>lib&#x2F;builder.js:1482</code></a>
1157 1157
         
1158 1158
         </p>
1159 1159
 
@@ -1244,7 +1244,7 @@ <h3 class="name"><code>filterFileName</code></h3>
1244 1244
             
1245 1245
         
1246 1246
         
1247  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1446"><code>lib&#x2F;builder.js:1446</code></a>
  1247
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1469"><code>lib&#x2F;builder.js:1469</code></a>
1248 1248
         
1249 1249
         </p>
1250 1250
 
@@ -1428,7 +1428,7 @@ <h3 class="name"><code>hasProperty</code></h3>
1428 1428
             
1429 1429
         
1430 1430
         
1431  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l927"><code>lib&#x2F;builder.js:927</code></a>
  1431
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l939"><code>lib&#x2F;builder.js:939</code></a>
1432 1432
         
1433 1433
         </p>
1434 1434
 
@@ -1782,7 +1782,7 @@ <h3 class="name"><code>mergeExtends</code></h3>
1782 1782
             
1783 1783
         
1784 1784
         
1785  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l944"><code>lib&#x2F;builder.js:944</code></a>
  1785
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l956"><code>lib&#x2F;builder.js:956</code></a>
1786 1786
         
1787 1787
         </p>
1788 1788
 
@@ -1983,7 +1983,7 @@ <h3 class="name"><code>nameSort</code></h3>
1983 1983
             
1984 1984
         
1985 1985
         
1986  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1294"><code>lib&#x2F;builder.js:1294</code></a>
  1986
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1317"><code>lib&#x2F;builder.js:1317</code></a>
1987 1987
         
1988 1988
         </p>
1989 1989
 
@@ -2722,7 +2722,7 @@ <h3 class="name"><code>renderAPIMeta</code></h3>
2722 2722
             
2723 2723
         
2724 2724
         
2725  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1416"><code>lib&#x2F;builder.js:1416</code></a>
  2725
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1439"><code>lib&#x2F;builder.js:1439</code></a>
2726 2726
         
2727 2727
         </p>
2728 2728
 
@@ -2815,7 +2815,7 @@ <h3 class="name"><code>renderClass</code></h3>
2815 2815
             
2816 2816
         
2817 2817
         
2818  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l989"><code>lib&#x2F;builder.js:989</code></a>
  2818
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1001"><code>lib&#x2F;builder.js:1001</code></a>
2819 2819
         
2820 2820
         </p>
2821 2821
 
@@ -2940,7 +2940,7 @@ <h3 class="name"><code>renderFile</code></h3>
2940 2940
             
2941 2941
         
2942 2942
         
2943  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1355"><code>lib&#x2F;builder.js:1355</code></a>
  2943
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1378"><code>lib&#x2F;builder.js:1378</code></a>
2944 2944
         
2945 2945
         </p>
2946 2946
 
@@ -3311,7 +3311,7 @@ <h3 class="name"><code>writeAPIMeta</code></h3>
3311 3311
             
3312 3312
         
3313 3313
         
3314  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1403"><code>lib&#x2F;builder.js:1403</code></a>
  3314
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1426"><code>lib&#x2F;builder.js:1426</code></a>
3315 3315
         
3316 3316
         </p>
3317 3317
 
@@ -3398,7 +3398,7 @@ <h3 class="name"><code>writeClasses</code></h3>
3398 3398
             
3399 3399
         
3400 3400
         
3401  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1259"><code>lib&#x2F;builder.js:1259</code></a>
  3401
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1282"><code>lib&#x2F;builder.js:1282</code></a>
3402 3402
         
3403 3403
         </p>
3404 3404
 
@@ -3485,7 +3485,7 @@ <h3 class="name"><code>writeFiles</code></h3>
3485 3485
             
3486 3486
         
3487 3487
         
3488  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1317"><code>lib&#x2F;builder.js:1317</code></a>
  3488
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l1340"><code>lib&#x2F;builder.js:1340</code></a>
3489 3489
         
3490 3490
         </p>
3491 3491
 
@@ -3659,7 +3659,7 @@ <h3 class="name"><code>writeModules</code></h3>
3659 3659
             
3660 3660
         
3661 3661
         
3662  
-        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l892"><code>lib&#x2F;builder.js:892</code></a>
  3662
+        <a href="..&#x2F;files&#x2F;lib_builder.js.html#l904"><code>lib&#x2F;builder.js:904</code></a>
3663 3663
         
3664 3664
         </p>
3665 3665
 
2  api/classes/DocParser.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/classes/DocView.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/classes/Files.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/classes/Help.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/classes/Index.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/classes/Options.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/classes/Server.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/classes/Utils.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/classes/YUIDoc.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
26  api/data.json
@@ -2,7 +2,7 @@
2 2
     "project": {
3 3
         "name": "YUIDoc",
4 4
         "description": "YUIDoc documentation tool written in Javascript",
5  
-        "version": "0.3.7",
  5
+        "version": "0.3.8",
6 6
         "url": "http://github.com/yui/yuidoc/issues",
7 7
         "logo": "http://yuilibrary.com/img/yui-logo.png"
8 8
     },
@@ -806,7 +806,7 @@
806 806
         },
807 807
         {
808 808
             "file": "lib/builder.js",
809  
-            "line": 892,
  809
+            "line": 904,
810 810
             "description": "Generates the module files under \"out\"/modules/",
811 811
             "itemtype": "method",
812 812
             "name": "writeModules",
@@ -822,7 +822,7 @@
822 822
         },
823 823
         {
824 824
             "file": "lib/builder.js",
825  
-            "line": 927,
  825
+            "line": 939,
826 826
             "description": "Checks an array of items (class items) to see if an item is in that list",
827 827
             "itemtype": "method",
828 828
             "name": "hasProperty",
@@ -846,7 +846,7 @@
846 846
         },
847 847
         {
848 848
             "file": "lib/builder.js",
849  
-            "line": 944,
  849
+            "line": 956,
850 850
             "description": "Merge superclass data into a child class",
851 851
             "itemtype": "method",
852 852
             "name": "mergeExtends",
@@ -867,7 +867,7 @@
867 867
         },
868 868
         {
869 869
             "file": "lib/builder.js",
870  
-            "line": 989,
  870
+            "line": 1001,
871 871
             "description": "Render the class file",
872 872
             "itemtype": "method",
873 873
             "name": "renderClass",
@@ -895,7 +895,7 @@
895 895
         },
896 896
         {
897 897
             "file": "lib/builder.js",
898  
-            "line": 1259,
  898
+            "line": 1282,
899 899
             "description": "Generates the class files under \"out\"/classes/",
900 900
             "itemtype": "method",
901 901
             "name": "writeClasses",
@@ -911,7 +911,7 @@
911 911
         },
912 912
         {
913 913
             "file": "lib/builder.js",
914  
-            "line": 1294,
  914
+            "line": 1317,
915 915
             "description": "Sort method of array of objects with a property called __name__",
916 916
             "itemtype": "method",
917 917
             "name": "nameSort",
@@ -936,7 +936,7 @@
936 936
         },
937 937
         {
938 938
             "file": "lib/builder.js",
939  
-            "line": 1317,
  939
+            "line": 1340,
940 940
             "description": "Generates the syntax files under `\"out\"/files/`",
941 941
             "itemtype": "method",
942 942
             "name": "writeFiles",
@@ -952,7 +952,7 @@
952 952
         },
953 953
         {
954 954
             "file": "lib/builder.js",
955  
-            "line": 1355,
  955
+            "line": 1378,
956 956
             "description": "Render the source file",
957 957
             "itemtype": "method",
958 958
             "name": "renderFile",
@@ -980,7 +980,7 @@
980 980
         },
981 981
         {
982 982
             "file": "lib/builder.js",
983  
-            "line": 1403,
  983
+            "line": 1426,
984 984
             "description": "Write the API meta data used for the AutoComplete widget",
985 985
             "itemtype": "method",
986 986
             "name": "writeAPIMeta",
@@ -997,7 +997,7 @@
997 997
         },
998 998
         {
999 999
             "file": "lib/builder.js",
1000  
-            "line": 1416,
  1000
+            "line": 1439,
1001 1001
             "description": "Render the API meta and return the Javascript",
1002 1002
             "itemtype": "method",
1003 1003
             "name": "renderAPIMeta",
@@ -1014,7 +1014,7 @@
1014 1014
         },
1015 1015
         {
1016 1016
             "file": "lib/builder.js",
1017  
-            "line": 1446,
  1017
+            "line": 1469,
1018 1018
             "description": "Normalizes a file path to a writable filename:\n\n   var path = 'lib/file.js';\n   returns 'lib_file.js';",
1019 1019
             "itemtype": "method",
1020 1020
             "name": "filterFileName",
@@ -1034,7 +1034,7 @@
1034 1034
         },
1035 1035
         {
1036 1036
             "file": "lib/builder.js",
1037  
-            "line": 1459,
  1037
+            "line": 1482,
1038 1038
             "description": "Compiles the templates from the meta-data provided by DocParser",
1039 1039
             "itemtype": "method",
1040 1040
             "name": "compile",
25  api/files/lib_builder.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
@@ -974,6 +974,18 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
974 974
                     });
975 975
                     opts.meta.moduleClasses.sort(self.nameSort);
976 976
                 }
  977
+                if (data.example &amp;&amp; data.example.length) {
  978
+                    if (data.example.forEach) {
  979
+                        var e = &#x27;&#x27;;
  980
+                        data.example.forEach(function(v) {
  981
+                            e += self._parseCode(self.markdown(v));
  982
+                        });
  983
+                        data.example = e;
  984
+                    } else {
  985
+                        data.example = self._parseCode(self.markdown(i.example));
  986
+                    }
  987
+                    opts.meta.example = data.example;
  988
+                }
977 989
                 if (data.submodules &amp;&amp; Object.keys(data.submodules).length) {
978 990
                     opts.meta.subModules = [];
979 991
                     Y.each(Object.keys(data.submodules), function(name) {
@@ -1181,6 +1193,17 @@ <h1 class="file-heading">File: lib&#x2F;builder.js</h1>
1181 1193
                     }
1182 1194
                     &#x2F;&#x2F;console.error(i);
1183 1195
                     opts.meta.is_constructor = [i];
  1196
+                    if (i.example &amp;&amp; i.example.length) {
  1197
+                        if (i.example.forEach) {
  1198
+                            var e = &#x27;&#x27;;
  1199
+                            i.example.forEach(function(v) {
  1200
+                                e += self._parseCode(self.markdown(v));
  1201
+                            });
  1202
+                            i.example = e;
  1203
+                        } else {
  1204
+                            i.example = self._parseCode(self.markdown(i.example));
  1205
+                        }
  1206
+                    }
1184 1207
                 }
1185 1208
 
1186 1209
                 classItems.forEach(function(i) {
2  api/files/lib_cli.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_docparser.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_docview.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_files.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_help.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_index.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_options.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_server.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_utils.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/files/lib_yuidoc.js.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
2  api/index.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
4  api/modules/yuidoc.html
@@ -19,7 +19,7 @@
19 19
             
20 20
         </div>
21 21
         <div class="yui3-u-1-4 version">
22  
-            <em>API Docs for: 0.3.7</em>
  22
+            <em>API Docs for: 0.3.8</em>
23 23
         </div>
24 24
     </div>
25 25
     <div id="bd" class="yui3-g">
@@ -132,6 +132,8 @@ <h2 class="off-left">APIs</h2>
132 132
 </code></pre>
133 133
 </div>
134 134
 
  135
+
  136
+
135 137
 <div class="yui3-g">
136 138
     <div class="yui3-u-1-2">
137 139
         
2  args/index.html
@@ -45,7 +45,7 @@ <h2 id="command-line">Running YUIDoc on the Command Line</h2>
45 45
 
46 46
 <pre class="code terminal">YUI Doc generates API documentation from a modified JavaDoc syntax.
47 47
 
48  
-Current version (0.3.7)
  48
+Current version (0.3.8)
49 49
 
50 50
 Usage: yuidoc &lt;options&gt; &lt;input path&gt;
51 51
 
4  index.html
@@ -24,7 +24,7 @@
24 24
     <div class="yui3-g">
25 25
         <div class="yui3-u-3-4">
26 26
             <div id="main">
27  
-                <div class="content"><h2 id="welcome-to-yuidoc-037">Welcome to YUIDoc 0.3.7!</h2>
  27
+                <div class="content"><h2 id="welcome-to-yuidoc-038">Welcome to YUIDoc 0.3.8!</h2>
28 28
 
29 29
 <div class="intro">
30 30
     <p>YUIDoc is a <a href="http://nodejs.org/">Node.js</a> application that
@@ -137,7 +137,7 @@ <h2 class="no-toc">Table of Contents</h2>
137 137
                         <div class="bd">
138 138
                             <ul class="toc">
139 139
 <li>
140  
-<a href="#welcome-to-yuidoc-037">Welcome to YUIDoc 0.3.7!</a>
  140
+<a href="#welcome-to-yuidoc-038">Welcome to YUIDoc 0.3.8!</a>
141 141
 </li>
142 142
 <li>
143 143
 <a href="##install">Installation and Usage</a>

0 notes on commit 0c09371

Please sign in to comment.
Something went wrong with that request. Please try again.