Minor tweaks to template.

tomyan · Jan 5, 2011 · 50faaaa · 50faaaa
1 parent 3cc8078
commit 50faaaa
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 29 deletions.
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
 	"name": "jsdoc",
 	"version": "3.0.0alpha1",
-	"revision": "2010-12-27-1223",
-	"description": "An automatic documentation generator for javascript",
+	"revision": "2011-01-05-2350",
+	"description": "An automatic documentation generator for javascript.",
 	"keywords": [ "documentation", "javascript" ],
 	"licenses": [
 		{
@@ -16,6 +16,13 @@
 			"url": "http://github.com/micmath/JSDoc"
 		}
 	],
+	"contributors" : [
+        {
+			"name": "Michael Mathews",
+			"email": "[email protected]",
+			"web": "http://micmath.ws"
+		}
+    ],
 	"maintainers": [
 		{
 			"name": "Michael Mathews",

diff --git a/templates/default/tmpl/index.html b/templates/default/tmpl/index.html
@@ -12,26 +12,32 @@
         }
 
         .namespace { color: #780000; }
-        .property { color: #999; }
-        .function { color: #999; }
+        .property { color: #666; }
+        .function { color: #666; }
 
-        .access { color: #999; }
+        .access { color: #666; }
 
-        dt
+        .symbol-head
         {
         	margin-top: 8px;
         	margin-bottom: 4px;
-        	border-top: 1px solid #ccc;
+        	padding: 6px;
         	font-size: 110%;
         	font-family: "Lucida Grande", "Lucida Sans Unicode", "Lucida Sans", Verdana, Tahoma, sans-serif;
+        	background-color: #B8B9CB;
         }
 
-        ol.params {
+        .detail-list {
             list-style-type:none;
         }
 
-        .summary {
+        .symbol-head .summary {
             font-style: italic;
+            color: #fff;
+            font-size: 90%;
+        }
+        .description {
+            margin-top: 12px;
         }
 
     </style>
@@ -43,15 +49,13 @@ <h1>All Symbols</h1>
 
 <dl>
 {{#docs}}
-    <dt class="symbol">
+    <h2 class="symbol-head">
         {{#kind}}<span class="kind {{kind}}">{{kind}}</span> {{/kind}}{{#access}}<span class="access {{access}}">&lt;{{access}}></span> {{/access}}{{longname}}
-    </dt>
-    <dd>
-        <div class="summary">
-        {{#summary}}
-            {{{summary}}}
-        {{/summary}}
-        </div>
+        <span class="summary">
+        {{#summary}}{{{summary}}}{{/summary}}
+        </span>
+    </h2>
+    <div>
 
         <div class="details">
             {{#description}}
@@ -61,29 +65,29 @@ <h1>All Symbols</h1>
             {{/description}}
 
             {{#borrowed?}}
-            <p>Mixes In:</p>
-            <ol class="borrows">
+            <h3>Mixes In:</h3>
+            <ol class="borrows detail-list">
                 {{#borrowed}} <li>{{from}}</li> {{/borrowed}}
             </ol>
             {{/borrowed?}}
 
             {{#params?}}
-            <p>Parameters:</p>
-            <ol class="params">
+            <h3>Parameters:</h3>
+            <ol class="params detail-list">
                 {{#params}} {{>param}} {{/params}}
             </ol>
             {{/params?}}
 
             {{#returns}}
-            <p>Returns:</p>
-            <ol class="params">
+            <h3>Returns:</h3>
+            <ol class="returns detail-list">
                 {{>returns}}
             </ol>
             {{/returns}}
         </div>
-    </dd>
+    </div>
 {{/docs}}
-</dl>
+
 
 </body>
 </html>
diff --git a/test/samples/jsdoc_test.js b/test/samples/jsdoc_test.js
@@ -104,13 +104,13 @@ geometry.Hexagon = function(sideLength) {
 /**
  * This is a global function that adds two integers together using {@link geometry.Shape#getClassName}.
  * @function
- * @param {int} One The first number to add 
- * @param {int} Two The second number to add 
+ * @param {int} oneNumber The first number to add 
+ * @param {int} twoNumber The second number to add 
  * @author Gabriel Reid
  * @deprecated So you shouldn't use it anymore! Use {@link geometry.Shape#getClassName} instead.
  */
-function Add(One, Two){
-    return One + Two;
+function Add(oneNumber, twoNumber){
+    return oneNumber + twoNumber;
 }