add enum values after signature doc

jenkinsci · Sep 3, 2015 · 9de7b7e · 9de7b7e
1 parent d5a2618
commit 9de7b7e
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 4 deletions.
diff --git a/job-dsl-api-viewer/src/css/main.less b/job-dsl-api-viewer/src/css/main.less
@@ -193,7 +193,7 @@ body {
 }
 
 .method-doc {
-  margin: 25px 0;
+  margin: 15px 0 15px 5px;
   text-align: left;
   pre {
     padding: 0;
@@ -212,10 +212,10 @@ body {
       background-color: @color2;
     }
     &.label-since {
-      background-color: @color4;
+      background-color: @color5;
     }
     &.label-deprecated {
-      background-color: @color5;
+      background-color: @color4;
     }
   }
   .signature {
@@ -225,6 +225,21 @@ body {
     text-align: left;
     display: block;
   }
+  .enums {
+    text-align: left;
+    margin-left: 5px;
+    margin-bottom: 10px;
+    ul {
+      padding: 0 0 0 20px;
+      margin: 0;
+      li {
+        font-family: monospace;;
+      }
+    }
+    .enum-title {
+      margin-bottom: 3px;
+    }
+  }
 }
 
 .code-block {

diff --git a/job-dsl-api-viewer/src/js/app.js b/job-dsl-api-viewer/src/js/app.js
@@ -199,9 +199,30 @@
                     comment: signature.firstSentenceCommentText
                 };
 
+                var enums = _.chain(signature.parameters)
+                    .filter(function(parameter) { return parameter.enumConstants; })
+                    .map(function(parameter) {
+                        var typeTokens = parameter.type.split('.');
+                        var simpleName = typeTokens[typeTokens.length - 1];
+                        return {
+                            paramName: parameter.name,
+                            values: parameter.enumConstants.map(function(v) { return simpleName + '.' + v; })
+                        };
+                    })
+                    .value();
+
+                if (enums.length) {
+                    data.enums = enums;
+                }
+
                 if (signature.plugin) {
                     data.plugin = signature.plugin;
-                    data.plugin.title = window.updateCenter.data.plugins[signature.plugin.id].title;
+                    var pluginData = window.updateCenter.data.plugins[signature.plugin.id];
+                    if (pluginData) {
+                        data.plugin.title = pluginData.title;
+                    } else {
+                        console.log('plugin not found', signature.plugin.id);
+                    }
                 }
 
                 return data;

diff --git a/job-dsl-api-viewer/src/templates/detail.hbs b/job-dsl-api-viewer/src/templates/detail.hbs
@@ -28,6 +28,20 @@
                 {{#if html}}
                     <div class="method-doc">{{{html}}}</div>
                 {{/if}}
+                {{#if enums}}
+                    <div class="enums">
+                    {{#each enums}}
+                        <div class="enum">
+                            <div class="enum-title">Possible values for <code>{{paramName}}</code>:</div>
+                            <ul>
+                                {{#each values}}
+                                    <li>{{this}}</li>
+                                {{/each}}
+                            </ul>
+                        </div>
+                    {{/each}}
+                    </div>
+                {{/if}}
             {{/each}}
         </div>
 

diff --git a/job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/doc/ApiDocGenerator.groovy b/job-dsl-core/src/main/groovy/javaposse/jobdsl/dsl/doc/ApiDocGenerator.groovy
@@ -245,6 +245,10 @@ class ApiDocGenerator {
             map.type = map.type.replaceAll('\\$', '.') // fix inner class names
         }
 
+        if (clazz.isEnum()) {
+            map.enumConstants = clazz.enumConstants*.toString()
+        }
+
         if (parameter.defaultValue()) {
             map.defaultValue = parameter.defaultValue()
         }