Taking over new template from jsdoc but keep modifications by OpenLayers as much as possible

2012-10-31 09:39:55 +01:00
parent f4139f208a
commit 64a252093c
17 changed files with 156 additions and 75 deletions
@@ -1,4 +1,7 @@
-<?js var self = this; ?>
+<?js
+var data = obj;
+var self = this;
+?>
 <dl class="details">
    <?js
        var properties = data.properties;
@@ -1,2 +1,2 @@
-
+<?js var data = obj; ?>
 <pre><code><?js= data ?></code></pre>
@@ -1,4 +1,5 @@
 <?js
+	var data = obj;
    data.forEach(function(example) {
        if (example.caption) {
    ?>
@@ -1,4 +1,7 @@
-<?js if (data.description) { ?>
+<?js
+	var data = obj;
+	if (data.description) {
+?>
 <div class="param-desc">
    <?js= description ?>
 </div>
@@ -1,3 +1,4 @@
+<?js var data = obj; ?>
 <li>
    <?js= data ?>
 </li>
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
    <meta charset="utf-8">
-    <title>OpenLayers <?js= title ?></title>
+    <title>OpenLayers: <?js= title ?></title>
    
    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
@@ -10,7 +10,7 @@
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
-    <link type="text/css" rel="stylesheet" href="styles/apidoc.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
 </head>

 <body>
@@ -1,4 +1,5 @@
 <?js
+var data = obj;
 var self = this;
 ?>

@@ -1,12 +1,12 @@
-
-<dt class="protected">
+<?js var data = obj; ?>
+<dt class="<?js= data.access ?>">
    <h4 class="name" id="<?js= id ?>"><?js= data.attribs + name + data.signature ?></h4>
    
    <?js if (data.summary) { ?>
    <p class="summary"><?js= summary ?></p>
    <?js } ?>
 </dt>
-<dd class="protected">
+<dd class="<?js= data.access ?>">
    <?js if (data.description) { ?>
    <div class="description">
        <?js= data.description ?>
@@ -1,4 +1,7 @@
-<?js var self = this; ?>
+<?js
+var data = obj;
+var self = this;
+?>
 <dt>
    <h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind == 'class'? 'new ':'') + name + data.signature ?></h4>
    
@@ -1,5 +1,5 @@
 <?js
-    var params = data;
+    var params = obj;
    
    /* sort subparams under their parent params (like opts.classname) */
    var parentParam = null;
@@ -47,6 +47,10 @@
 		
 		<th>Type</th>
 		
+		<?js if (params.hasAttributes) {?>
+		<th>Argument</th>
+		<?js } ?>
+		
 		<?js if (params.hasDefault) {?>
 		<th>Default</th>
 		<?js } ?>
@@ -73,6 +77,18 @@
            <?js } ?>
            </td>
            
+            <?js if (params.hasAttributes) {?>
+                <td class="attributes">
+                <?js if (param.optional) { ?>
+                    &lt;optional><br>
+                <?js } ?>
+                    
+                <?js if (param.nullable) { ?>
+                    &lt;nullable><br>
+                <?js } ?>
+                </td>
+            <?js } ?>
+            
            <?js if (params.hasDefault) {?>
                <td class="default">
                <?js if (typeof param.defaultvalue !== 'undefined') { ?>
@@ -1,5 +1,5 @@
 <?js
-    var props = data;
+    var props = obj;
    
    /* sort subprops under their parent props (like opts.classname) */
    var parentProp = null;
@@ -1,4 +1,7 @@
-<?js if (data.description) { ?>
+<?js
+var data = obj;
+if (data.description) {
+?>
 <div class="param-desc">
    <?js= description ?>
 </div>
@@ -1,4 +1,5 @@
 <?js
+	var data = obj;
    var self = this;
    data.forEach(function(name, i) { ?>
 <span class="param-type"><?js= self.linkto(name, self.htmlsafe(name)) ?></span>