Mercurial > public > gradleplugins

annotate src/main/resources/org/ssdt_ohio/gradle/userdoc/templates/classDocName.html @ 23:e2d02e8742be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
usasr-1307: for render tables for properties and reportable properties with label and group names
author smith@nwoca.org
date Wed, 16 Mar 2016 23:24:26 +0100
parents e8e14d5d6be2
children
rev   line source
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
1 <!--
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
2
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
3 Licensed to the Apache Software Foundation (ASF) under one
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
4 or more contributor license agreements. See the NOTICE file
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
5 distributed with this work for additional information
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
6 regarding copyright ownership. The ASF licenses this file
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
7 to you under the Apache License, Version 2.0 (the
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
8 "License"); you may not use this file except in compliance
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
9 with the License. You may obtain a copy of the License at
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
10
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
11 http://www.apache.org/licenses/LICENSE-2.0
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
12
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
13 Unless required by applicable law or agreed to in writing,
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
14 software distributed under the License is distributed on an
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
15 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
16 KIND, either express or implied. See the License for the
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
17 specific language governing permissions and limitations
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
18 under the License.
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
19
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
20 -->
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
21 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
22 <!-- **************************************************************** -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
23 <!-- * PLEASE KEEP COMPLICATED EXPRESSIONS OUT OF THESE TEMPLATES, * -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
24 <!-- * i.e. only iterate & print data where possible. Thanks, Jez. * -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
25 <!-- **************************************************************** -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
26 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
27
17
3741247de37a USASR-1307: add helper to resolve template classpath problem
smith@nwoca.org
parents: 16
diff changeset
28 classDoc = props.get('userdocHelper').wrap(classDoc)
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
29
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
30 def title = classDoc.name() + (props.docTitle ? " (${props.docTitle})" : "")
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
31 def isVisible = { it.isPublic() || (it.isProtected() && props.protectedScope == 'true') || (!it.isProtected() && !it.isPrivate() && props.packageScope == 'true') || props.privateScope == 'true' }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
32 def isVisibleExt = { t -> java.lang.reflect.Modifier.isPublic(t.modifiers) || java.lang.reflect.Modifier.isProtected(t.modifiers) }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
33 def visibleFields = classDoc.fields().findAll(isVisible)
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
34 def visibleProperties = classDoc.properties() // props visible be def
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
35 def visibleMethods = classDoc.methods().findAll(isVisible)
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
36 def getterMethods = visibleMethods.findAll { it.name().startsWith('get') }
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
37 def nonGetterMethods = visibleMethods - getterMethods
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
38
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
39 def visibleConstructors = classDoc.constructors().findAll(isVisible)
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
40 def visibleNested = classDoc.innerClasses().findAll(isVisible)
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
41 boolean hasFields = !classDoc.isAnnotationType() && visibleFields
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
42 boolean hasProperties = !classDoc.isAnnotationType() && visibleProperties
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
43 boolean hasElements = classDoc.isAnnotationType() && visibleFields
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
44 boolean methodSummaryShown = visibleMethods
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
45 boolean fieldSummaryShown = hasFields
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
46 boolean hasEnumConstants = classDoc.enumConstants()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
47 def dolink = { t, boolean b ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
48 boolean isArray = false
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
49 if (!t || t instanceof String) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
50 return classDoc.getDocUrl(t, b)
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
51 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
52 if (t instanceof org.codehaus.groovy.tools.groovydoc.ArrayClassDocWrapper) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
53 t = t.delegate
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
54 isArray = true
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
55 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
56 if (t instanceof org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
57 if (t.fullPathName == 'def') return classDoc.getDocUrl("java.lang.Object def", b)
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
58 if (!t.qualifiedTypeName().contains("<") && t.name().size() > 1)
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
59 return "<a href='" + classDoc.relativeRootPath + t.fullPathName + ".html'>" + (b ? t.qualifiedTypeName() : t.name()) + "</a>" + (isArray ? "[]" : "")
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
60 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
61 return classDoc.getDocUrl(t.qualifiedTypeName(), b) + (isArray ? "[]" : "")
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
62 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
63 def linkfull = { t -> dolink(t, true) - "java.lang." - "java.util." }
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
64 def linkable = { t -> dolink(t, false) - "java.lang." - "java.util." }
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
65 def modifiersWithIgnore = { t, boolean ignorePublic ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
66 (t.isPrivate()?"private&nbsp;":"") +
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
67 (t.isPublic() && !ignorePublic?"public&nbsp;":"") +
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
68 (t.isProtected()?"protected&nbsp;":"") +
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
69 (t.isStatic()?"static&nbsp;":"") +
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
70 (t.isFinal()?"final&nbsp;":"") +
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
71 (t.respondsTo('isAbstract') && t.isAbstract()?"abstract&nbsp;":"")
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
72 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
73 def modifiers = { t -> modifiersWithIgnore(t, classDoc.isGroovy()) }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
74 def modifiersBrief = { t ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
75 (t.isPrivate()?"private&nbsp;":"") +
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
76 (t.isProtected()?"protected&nbsp;":"") +
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
77 (t.isStatic()?"static&nbsp;":"")
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
78 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
79 def annotations = { t, sepChar ->
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
80 t.annotations() ? t.annotations().collect{it.isTypeAvailable()?'@'+linkable(it.type().name())+(it.description()-('@'+it.type().name())):it.description()}.join(sepChar) + sepChar : ''
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
81 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
82 def elementTypes = [
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
83 "required":"true",
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
84 "optional":"false"
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
85 ]
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
86 def isRequired = { f, v -> def req = f.constantValueExpression() == null; req.toString() == v }
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
87 def upcase = { n -> n[0].toUpperCase() + n[1..-1] }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
88 def lowcase = { n -> n ? n[0].toLowerCase() + n[1..-1] : "" }
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
89 def paramsOf = { n, boolean brief -> n.parameters().collect{ param -> (brief?'':annotations(param, ' ')) + linkable(param.isTypeAvailable()?param.type():param.typeName()) + (param.vararg()?'... ':' ') + param.name() + (param.defaultValue() ? " = " + param.defaultValue():"") }.join(", ") }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
90 def nameFromParams = { n -> n.name() + '(' + n.parameters().collect{ param -> param.isTypeAvailable()?param.type().qualifiedTypeName():param.typeName() }.join(', ') + ')' }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
91 def nameFromJavaParams = { n -> n.name + '(' + n.parameterTypes.collect{ param -> param.name }.join(', ') + ')' }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
92 def asPropertyName = { lowcase(it - 'get') }
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
93 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
94 <html>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
95 <head>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
96 <!-- Generated by groovydoc (${GroovySystem.version}) on ${new Date()} -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
97 <title>${title}</title>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
98 <meta name="date" content="${new Date().format('yyyy-MM-dd')}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
99 <meta http-equiv="Content-Type" content="text/html; charset=${props.charset}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
100 <link href="${classDoc.relativeRootPath}groovy.ico" type="image/x-icon" rel="shortcut icon">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
101 <link href="${classDoc.relativeRootPath}groovy.ico" type="image/x-icon" rel="icon">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
102 <link rel="stylesheet" type="text/css" href="${classDoc.relativeRootPath}stylesheet.css" title="Style">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
103
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
104 <body class="center">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
105 <script type="text/javascript"><!--
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
106 if (location.href.indexOf('is-external=true') == -1) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
107 parent.document.title="${title}";
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
108 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
109 //-->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
110 </script>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
111 <noscript>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
112 <div>JavaScript is disabled on your browser.</div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
113 </noscript>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
114 <!-- ========= START OF TOP NAVBAR ======= -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
115 <div class="topNav"><a name="navbar_top">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
116 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
117 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
118 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
119 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
120 <ul class="navList" title="Navigation">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
121 <li><a href="${classDoc.relativeRootPath}overview-summary.html">Overview</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
122 <li><a href="package-summary.html">Package</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
123 <li class="navBarCell1Rev">Class</li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
124 <li><a href="${classDoc.relativeRootPath}deprecated-list.html">Deprecated</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
125 <li><a href="${classDoc.relativeRootPath}index-all.html">Index</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
126 <li><a href="${classDoc.relativeRootPath}help-doc.html">Help</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
127 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
128 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
129
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
130 <div class="subNav">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
131 <div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
132 <ul class="navList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
133 <li><a href="${classDoc.relativeRootPath}index.html?${classDoc.fullPathName}" target="_top">Frames</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
134 <li><a href="${classDoc.name()}.html" target="_top">No Frames</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
135 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
136 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
137 <div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
138 <ul class="subNavList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
139 <li>Summary:&nbsp;</li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
140 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
141 if (classDoc.isAnnotationType()) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
142 def hasReq = classDoc.fields().any{ isRequired(it, "true") }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
143 def hasOpt = classDoc.fields().any{ isRequired(it, "false") }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
144 if (hasReq) { %><li><a href="#required_element_summary"><% } %>Required<% if (hasReq) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
145 if (hasOpt) { %><li><a href="#optional_element_summary"><% } %>Optional<% if (hasOpt) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
146 } else {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
147 if (visibleNested) { %><li><a href="#nested_summary"><% } %>Nested<% if (visibleNested) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
148 if (classDoc.isEnum()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
149 if (hasEnumConstants) { %><li><a href="#enum_constant_summary"><% } %>Enum constants<% if (hasEnumConstants) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
150 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
151 if (hasFields) { %><li><a href="#field_summary"><% } %>Field<% if (hasFields) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
152 if (hasProperties) { %><li><a href="#property_summary">Property</a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
153 if (classDoc.isClass()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
154 if (visibleConstructors) { %><li><a href="#constructor_summary"><% } %>Constructor<% if (visibleConstructors) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
155 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
156 if (visibleMethods) { %><li><a href="#method_summary"><% } %>Method<% if (visibleMethods) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
157 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
158 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
159 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
160 <ul class="subNavList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
161 <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
162 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
163 if (classDoc.isAnnotationType()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
164 if (hasElements) { %><li><a href="#element_detail"><% } %>Element<% if (hasElements) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
165 } else {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
166 if (classDoc.isEnum()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
167 if (hasEnumConstants) { %><li><a href="#enum_constant_detail"><% } %>Enum constants<% if (hasEnumConstants) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
168 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
169 if (hasFields) { %><li><a href="#field_detail"><% } %>Field<% if (hasFields) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
170 if (hasProperties) { %><li><a href="#prop_detail">Property</a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
171 if (classDoc.isClass()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
172 if (visibleConstructors) { %><li><a href="#constructor_detail"><% } %>Constructor<% if (visibleConstructors) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
173 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
174 if (visibleMethods) { %><li><a href="#method_detail"><% } %>Method<% if (visibleMethods) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
175 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
176 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
177 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
178 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
179 <a name="skip-navbar_top">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
180 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
181 </a></div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
182 <!-- ========= END OF TOP NAVBAR ========= -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
183
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
184 <!-- ======== START OF CLASS DATA ======== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
185 <div class="header">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
186 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
187 def pkg = classDoc.containingPackage().nameWithDots()
20
e8e14d5d6be2 improve formatting. exclude @transient and version
smith@nwoca.org
parents: 17
diff changeset
188 String classDesc = "${classDoc.typeDescription} ${org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc.encodeAngleBrackets(classDoc.getNameWithTypeArgs())}"
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
189 if (pkg != "DefaultPackage") {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
190 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
191 <div class="subTitle">Package: <strong>${pkg}</strong></div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
192 <%}%>
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
193 <h2 title="${classDesc}" class="title">${classDesc}
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
194 <% if (classDoc.superclass()) { %> extends ${linkable(classDoc.superclass())} <% } %>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
195 </h2>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
196 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
197 <div class="contentContainer">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
198 <ul class="inheritance">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
199 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
200 def parents = classDoc.isInterface() ? classDoc.parentInterfaces : classDoc.parentClasses
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
201 if (parents.size() >= 2) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
202 parents.eachWithIndex { p, i ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
203 %><li><%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
204 if ( i == parents.size() - 1) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
205 out << p.qualifiedTypeName()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
206 } else {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
207 %><ul class="inheritance"><% linkfull(p) %></ul></li><%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
208 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
209 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
210 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
211 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
212 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
213 <div class="description">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
214 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
215 <li class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
216 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
217 if (classDoc.isInterface()) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
218 Set interfaces = classDoc.parentInterfaces
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
219 interfaces -= classDoc
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
220 if (interfaces) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
221 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
222 <dl>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
223 <dt>All Superinterfaces:</dt>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
224 <dd>${interfaces.collect{ linkable(it) }.join(', ')}</dd>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
225 </dl><%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
226 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
227 } else {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
228 // TODO follow up the tree collecting interfaces seen?
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
229 def interfaces = classDoc.interfaces()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
230 if (interfaces) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
231 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
232 <dl>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
233 <dt>All Implemented Interfaces and Traits:</dt>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
234 <dd>${interfaces.collect{ linkable(it) }.join(', ')}</dd>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
235 </dl>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
236 <!-- todo: direct known subclasses -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
237 <hr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
238 <br>
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
239 <div>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
240 ${ annotations(classDoc, '<br/>')}
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
241 </div>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
242 <pre>${modifiers(classDoc) + classDoc.typeSourceDescription + ' ' + classDoc.name()}
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
243 <% if (classDoc.isInterface() && classDoc.interfaces()) {%>extends ${classDoc.interfaces().collect{ linkable(it) }.join(', ')}
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
244 <% } else if (classDoc.superclass()) { %>extends ${linkable(classDoc.superclass())}
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
245 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
246 </pre>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
247 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
248 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
249 <% if (classDoc.commentText()) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
250 <p>${classDoc.commentText()}</p>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
251 <% } %>
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
252 </li>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
253 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
254 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
255
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
256 <div class="summary">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
257 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
258 <li class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
259 <!-- =========== NESTED CLASS SUMMARY =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
260 <% if (visibleNested) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
261 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
262 <li class="blockList"><a name="nested_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
263 <h3>Nested Class Summary</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
264 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
265 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
266 <caption><span>Nested classes</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
267 <tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
268 <th class="colFirst" scope="col">Modifiers</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
269 <th class="colLast" scope="col">Name</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
270 <th class="colLast" scope="col">Description</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
271 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
272 <% visibleNested.eachWithIndex { c, i -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
273 <tr class="${i%2==0?'altColor':'rowColor'}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
274 <td class="colFirst"><code><strong>${modifiersBrief(c) + c.typeSourceDescription}</strong></code>&nbsp;</td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
275 <td class="colLast"><code>${linkable(c)}</code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
276 <td class="colLast">${c.firstSentenceCommentText()}</code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
277 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
278 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
279 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
280 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
281 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
282 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
283 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
284
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
285 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
286 <% if (hasEnumConstants) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
287 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
288 <li class="blockList"><a name="enum_constant_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
289 <h3>Enum Constants Summary</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
290 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
291 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum constants summary table">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
292 <caption><span>Enum constants classes</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
293 <tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
294 <th class="colFirst" scope="col">Enum constant</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
295 <th class="colLast" scope="col">Description</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
296 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
297 <% classDoc.enumConstants().eachWithIndex { ec, i -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
298 <tr class="${i%2==0?'altColor':'rowColor'}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
299 <td class="colFirst"><code><strong><a href="#${ec.name()}">${ec.name()}</a></strong></code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
300 <td class="colLast">${ec.firstSentenceCommentText()}</td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
301 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
302 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
303 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
304 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
305 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
306 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
307 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
308 <!-- =========== FIELD SUMMARY =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
309 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
310 def buffer = new StringBuilder()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
311 classes = []
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
312 if (classDoc.isInterface()) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
313 classes.addAll(classDoc.interfaces().toList())
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
314 } else {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
315 if (classDoc.superclass()) classes += classDoc.superclass()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
316 else classes += new org.codehaus.groovy.tools.groovydoc.ExternalGroovyClassDoc(Object.class)
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
317 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
318 visited = [classDoc] as Set
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
319 while (classes) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
320 Set nextLevel = []
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
321 classes.eachWithIndex { c,i ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
322 if (c.isInterface()) nextLevel.addAll(c.interfaces().toList())
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
323 else if (c.superclass() && c.qualifiedTypeName() != 'java.lang.Object') nextLevel += c.superclass()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
324 nextLevel -= visited
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
325 visited += nextLevel
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
326 def list = []
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
327 if (c instanceof org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
328 list = c.fields().findAll(isVisible).collect { field ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
329 "<a href='${classDoc.relativeRootPath}${c.fullPathName}.html#${field.name()}'>${field.name()}</a>"
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
330 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
331 } else {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
332 list = c.externalClass().fields.findAll{ isVisibleExt(it) }.collect { field ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
333 // "<a href='${classDoc.relativeRootPath}${c.fullPathName}.html#${field.name()}'>${field.name()}</a>"
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
334 field.name
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
335 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
336 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
337 if (list) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
338 buffer << """ <tr class="${i%2==0?'altColor':'rowColor'}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
339 <td class="colFirst"><strong><code>${c.typeSourceDescription} ${linkable(c)}</code></strong></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
340 <td class="colLast"><code>${list.join(', ')}</code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
341 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
342 """
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
343 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
344 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
345 classes = nextLevel
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
346 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
347
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
348
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
349 if (hasFields || buffer.length()>0) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
350 <ul class="blockList"><%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
351 if (hasFields) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
352 <li class="blockList"><a name="field_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
353 <h3>Field Summary</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
354 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
355 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum constants summary table">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
356 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
357 <tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
358 <th class="colFirst" scope="col">Modifiers</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
359 <th class="colLast" scope="col">Name</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
360 <th class="colLast" scope="col">Description</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
361 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
362 <% visibleFields.eachWithIndex { field, i -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
363 <tr class="${i%2==0?'altColor':'rowColor'}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
364 <td class="colFirst"><code><strong>${modifiersBrief(field) + linkable(field.type())}</strong></code>&nbsp;</td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
365 <td class="colLast"><code><a href="#${field.name()}">${field.name()}</a></code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
366 <td class="colLast">${field.firstSentenceCommentText()}</code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
367 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
368 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
369 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
370 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
371 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
372 <% } // if (hasFields)
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
373 if ((buffer.length())>0) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
374 <li class="blockList"><a name="field_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
375 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
376 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited fields summary table">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
377 <caption><span>Inherited fields</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
378 <tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
379 <th class="colFirst" scope="col">Fields inherited from class</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
380 <th class="colLast" scope="col">Fields</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
381 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
382 ${buffer}
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
383 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
384 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
385 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
386 <% } // if buffer %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
387 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
388 <% } // if hasFields or buffer %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
389
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
390 <!-- =========== PROPERTY SUMMARY =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
391 <% if (hasProperties) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
392 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
393 <li class="blockList"><a name="property_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
394 <h3>Properties Summary</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
395 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
396 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Properties Summary table, listing nested classes, and an explanation">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
397 <caption><span>Properties</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
398 <tr>
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
399 <th class="colFirst" scope="col">Name</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
400 <th class="col" scope="col">Type</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
401 <th class="col" scope="col">Label</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
402 <th class="col" scope="col">Group</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
403 <th class="colLast" scope="col">Description</th>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
404 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
405 <% visibleProperties.eachWithIndex { prop, i -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
406 <tr class="${i%2==0?'altColor':'rowColor'}">
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
407 <td class="colFirst"><code><a href="#${prop.name()}">${prop.name()}</a></code></td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
408 <td class="col"><code><strong>${modifiersBrief(prop) + linkable(prop.type())}</strong></code>&nbsp;</td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
409 <td class="col"> ${classDoc.getLabel(prop)} </td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
410 <td class="col"> ${classDoc.getGroup(prop)} </td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
411 <td class="colLast">${prop.firstSentenceCommentText()}</td>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
412 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
413 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
414 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
415 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
416 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
417 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
418 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
419
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
420 <!-- =========== ELEMENT SUMMARY =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
421 <% if (hasElements) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
422 <ul class="blockList"><a name="element_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
423 <li class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
424 <h3>Element Summary</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
425 <% elementTypes.each { k, v ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
426 %><a name="${k}_element_summary"><!-- --></a><%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
427 if (visibleFields.any{ isRequired(it, v) }) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
428 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
429 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="${upcase(k)} Element Summary table">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
430 <caption><span>${upcase(k)} Element Summary</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
431 <tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
432 <th class="colFirst" scope="col">Type</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
433 <th class="colLast" scope="col">Name and Description</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
434 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
435 <% visibleFields.findAll {isRequired(it, v)}.eachWithIndex { element, i -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
436 <tr class="${i%2==0?'altColor':'rowColor'}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
437 <td class="colFirst"><code><strong>${modifiersBrief(element) + linkable(element.type())}</strong></code>&nbsp;</td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
438 <td class="colLast"><code><a href="#${element.name()}">${element.name()}</a></code><br>${element.firstSentenceCommentText()}</td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
439 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
440 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
441 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
442 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
443 <% }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
444 } //elementTypes.each %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
445 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
446 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
447 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
448
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
449 <% if (visibleConstructors) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
450 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
451 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
452 <li class="blockList"><a name="constructor_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
453 <h3>Constructor Summary</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
454 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
455 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructors Summary table">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
456 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
457 <tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
458 <th class="colFirst" scope="col">Constructor and description</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
459 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
460 <% visibleConstructors.eachWithIndex { constructor, i -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
461 <tr class="${i%2==0?'altColor':'rowColor'}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
462 <td class="colFirst">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
463 <code>${modifiersBrief(constructor)}<a href="#${nameFromParams(constructor)}">${constructor.name()}</a></strong>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
464 (${paramsOf(constructor, true)})</code><br>${constructor.firstSentenceCommentText()}</td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
465 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
466 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
467 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
468 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
469 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
470 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
471 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
472
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
473 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
474 buffer = new StringBuilder()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
475 Set classes = []
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
476 if (classDoc.isInterface()) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
477 classes.addAll(classDoc.interfaces().toList())
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
478 } else {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
479 if (classDoc.superclass()) classes += classDoc.superclass()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
480 else if (!classDoc.isTrait()) classes += new org.codehaus.groovy.tools.groovydoc.ExternalGroovyClassDoc(Object.class)
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
481 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
482 Set visited = [classDoc] as Set
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
483 while (classes) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
484 Set nextLevel = []
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
485 classes.eachWithIndex { c,i ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
486 if (c.isInterface()) nextLevel.addAll(c.interfaces().toList())
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
487 else if (c.superclass() && c.qualifiedTypeName() != 'java.lang.Object') nextLevel += c.superclass()
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
488 nextLevel -= visited
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
489 visited += nextLevel
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
490 def list = []
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
491 if (c instanceof org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
492 list = c.methods().findAll(isVisible).collect { method ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
493 "<a href='${classDoc.relativeRootPath}${c.fullPathName}.html#${nameFromParams(method)}'>${method.name()}</a>"
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
494 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
495 } else {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
496 list = c.externalClass().methods.findAll{ isVisibleExt(it) }.collect { method ->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
497 linkable(c.externalClass().name + "#" + nameFromJavaParams(method) + " " + method.name)
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
498 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
499 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
500 if (list) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
501 buffer << """
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
502 <tr class="${i%2==0?'altColor':'rowColor'}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
503 <td class="colFirst"><code>${c.typeSourceDescription} ${linkable(c)}</strong></code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
504 <td class="colLast"><code>${list.join(', ')}</code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
505 </tr>"""
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
506 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
507 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
508 classes = nextLevel
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
509 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
510
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
511 if (visibleMethods || buffer.length()>0) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
512 <!-- ========== METHOD SUMMARY =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
513 <ul class="blockList">
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
514 <% if (getterMethods) { %>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
515 <li class="blockList"><a name="method_summary"><!-- --></a>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
516 <h3>Reportable Properties Summary</h3>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
517 <ul class="blockList">
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
518 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Reportable Properties Summary table">
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
519 <caption><span>Reportable Properties</span><span class="tabEnd">&nbsp;</span></caption>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
520 <tr>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
521 <th class="colFirst" scope="col">Name</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
522 <th class="col" scope="col">Type</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
523 <th class="col" scope="col">Label</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
524 <th class="col" scope="col">Group</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
525 <th class="colLast" scope="col">Description</th>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
526 </tr>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
527 <% getterMethods.eachWithIndex { method, i -> %>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
528 <tr class="${i%2==0?'altColor':'rowColor'}">
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
529 <td class="colFirst"><code><strong><a href="#${nameFromParams(method)}">${asPropertyName(method.name())}</a></strong></code></td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
530 <td class="col"><code>${modifiersBrief(method)}${linkable(method.returnType())}</strong></code></td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
531 <td class="col">${classDoc.getLabel(method)}</td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
532 <td class="col">${classDoc.getGroup(method)}</td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
533 <td class="colLast">${method.firstSentenceCommentText()}</td>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
534 </tr>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
535 <% } %>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
536 </table>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
537 </ul>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
538 </li>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
539 <% } // if (getterMethods) %>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
540
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
541 <% if (nonGetterMethods) { %>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
542 <li class="blockList"><a name="method_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
543 <h3>Methods Summary</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
544 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
545 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Methods Summary table">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
546 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
547 <tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
548 <th class="colFirst" scope="col">Type</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
549 <th class="colLast" scope="col">Name and description</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
550 </tr>
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
551 <% nonGetterMethods.eachWithIndex { method, i -> %>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
552 <tr class="${i%2==0?'altColor':'rowColor'}">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
553 <td class="colFirst"><code>${modifiersBrief(method)}${linkable(method.returnType())}</strong></code></td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
554 <td class="colLast"><code><strong><a href="#${nameFromParams(method)}">${method.name()}</a></strong>(${paramsOf(method, true)})</code><br>${method.firstSentenceCommentText()}</td>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
555 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
556 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
557 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
558 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
559 </li>
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
560 <% } // if (nonGetterMethods)
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
561 if (buffer.length()>0) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
562 %>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
563 <li class="blockList"><a name="method_summary"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
564 <h3>Inherited Methods Summary</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
565 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
566 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Inherited Methods Summary table">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
567 <caption><span>Inherited Methods</span><span class="tabEnd">&nbsp;</span></caption>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
568 <tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
569 <th class="colFirst" scope="col">Methods inherited from class</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
570 <th class="colLast" scope="col">Name</th>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
571 </tr>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
572 ${buffer}
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
573 </table>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
574 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
575 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
576 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
577 } // if buffer.length%>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
578 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
579 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
580 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
581 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
582 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
583
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
584 <div class="details">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
585 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
586 <li class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
587 <% if (hasEnumConstants) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
588 <!-- ============ ENUM CONSTANT DETAIL ========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
589 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
590 <li class="blockList"><a name="enum_constant_detail">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
591 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
592 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
593 <h3>Enum Constant Detail</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
594 <% for (ec in classDoc.enumConstants()) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
595 <a name="${ec.name()}"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
596 <ul class="blockListLast">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
597 <li class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
598 <h4>${modifiers(ec) + '<a href="' + classDoc.relativeRootPath + classDoc.fullPathName + '.html">' + classDoc.name() + '</a>'} <strong>${ec.name()}</strong></h4>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
599 <p>${ec.commentText()}</p>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
600 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
601 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
602 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
603 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
604 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
605 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
606
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
607 <% if (hasFields) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
608 <!-- =========== FIELD DETAIL =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
609 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
610 <li class="blockList"><a name="field_detail">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
611 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
612 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
613 <h3>Field Detail</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
614 <% visibleFields.each { field -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
615 <a name="${field.name()}"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
616 <ul class="blockListLast">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
617 <li class="blockList">
20
e8e14d5d6be2 improve formatting. exclude @transient and version
smith@nwoca.org
parents: 17
diff changeset
618 <pre>${annotations(field, '\n')}</pre> ${modifiersWithIgnore(field, false) + linkable(field.type())} <h4>${field.name()}</h4>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
619 <p>${field.commentText()}</p>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
620 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
621 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
622 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
623 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
624 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
625 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
626
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
627 <% if (hasProperties) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
628 <!-- =========== PROPERTY DETAIL =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
629 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
630 <li class="blockList"><a name="prop_detail">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
631 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
632 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
633 <h3>Property Detail</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
634 <% visibleProperties.each { prop -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
635 <a name="${prop.name()}"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
636 <ul class="blockListLast">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
637 <li class="blockList">
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
638 <h4>${prop.name()}</h4>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
639 <h5>Type: ${ modifiers(prop) + linkable(prop.type()) }</h5>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
640 <div>${annotations(prop, '<br/>') } </div>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
641 <p>${prop.commentText()}</p>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
642 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
643 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
644 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
645 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
646 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
647 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
648
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
649 <% if (hasElements) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
650 <!-- =========== ELEMENT DETAIL =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
651 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
652 <li class="blockList"><a name="element_detail">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
653 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
654 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
655 <h3>Element Detail</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
656 <% visibleFields.each { element -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
657 <a name="${element.name()}"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
658 <ul class="blockListLast">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
659 <li class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
660 <h4>${modifiers(element) + linkable(element.type())} <strong>${element.name()}</strong></h4>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
661 <p>${element.commentText()}</p>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
662 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
663 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
664 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
665 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
666 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
667 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
668
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
669 <% if (visibleConstructors) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
670 <!-- =========== CONSTRUCTOR DETAIL =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
671 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
672 <li class="blockList"><a name="constructor_detail">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
673 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
674 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
675 <h3>Constructor Detail</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
676 <% visibleConstructors.each { constructor -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
677 <a name="${nameFromParams(constructor)}"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
678 <ul class="blockListLast">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
679 <li class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
680 <h4>${annotations(constructor, '\n') + modifiers(constructor)}<strong>${constructor.name()}</strong>(${paramsOf(constructor, false)})</h4>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
681 <p>${constructor.commentText()}</p>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
682 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
683 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
684 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
685 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
686 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
687 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
688
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
689
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
690 <% if (visibleMethods) { %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
691 <!-- =========== METHOD DETAIL =========== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
692 <ul class="blockList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
693 <li class="blockList"><a name="method_detail">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
694 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
695 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
696 <h3>Method Detail</h3>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
697 <% visibleMethods.each { method -> %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
698 <a name="${nameFromParams(method)}"><!-- --></a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
699 <ul class="blockListLast">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
700 <li class="blockList">
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
701 <h4>${method.name()}(${paramsOf(method, false)}) </h4>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
702 <h5>Type: ${ modifiers(method) + linkable(method.returnType()) }</h5>
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
703 <div>${annotations(method, '<br/>') } </div>
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
704 <p>${method.commentText()}</p>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
705 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
706 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
707 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
708 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
709 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
710 <% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
711 </li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
712 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
713 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
714
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
715 <!-- ========= END OF CLASS DATA ========= -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
716 <!-- ======= START OF BOTTOM NAVBAR ====== -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
717 <div class="bottomNav"><a name="navbar_bottom">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
718 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
719 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
720 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
721 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
722 <ul class="navList" title="Navigation">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
723 <li><a href="${classDoc.relativeRootPath}overview-summary.html">Overview</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
724 <li><a href="package-summary.html">Package</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
725 <li class="navBarCell1Rev">Class</li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
726 <li><a href="${classDoc.relativeRootPath}deprecated-list.html">Deprecated</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
727 <li><a href="${classDoc.relativeRootPath}index-all.html">Index</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
728 <li><a href="${classDoc.relativeRootPath}help-doc.html">Help</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
729 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
730 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
731
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
732 <div class="subNav">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
733 <div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
734 <ul class="navList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
735 <li><a href="${classDoc.relativeRootPath}index.html?${classDoc.fullPathName}" target="_top">Frames</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
736 <li><a href="${classDoc.name()}.html" target="_top">No Frames</a></li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
737 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
738 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
739 <div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
740 <ul class="subNavList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
741 <li>Summary:&nbsp;</li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
742 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
743 if (classDoc.isAnnotationType()) {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
744 def hasReq = classDoc.fields().any{ isRequired(it, "true") }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
745 def hasOpt = classDoc.fields().any{ isRequired(it, "false") }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
746 if (hasReq) { %><li><a href="#required_element_summary"><% } %>Required<% if (hasReq) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
747 if (hasOpt) { %><li><a href="#optional_element_summary"><% } %>Optional<% if (hasOpt) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
748 } else {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
749 if (visibleNested) { %><li><a href="#nested_summary"><% } %>Nested<% if (visibleNested) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
750 if (classDoc.isEnum()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
751 if (hasEnumConstants) { %><li><a href="#enum_constant_summary"><% } %>Enum constants<% if (hasEnumConstants) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
752 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
753 if (hasFields) { %><li><a href="#field_summary"><% } %>Field<% if (hasFields) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
754 if (hasProperties) { %><li><a href="#property_summary">Property</a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
755 if (classDoc.isClass()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
756 if (visibleConstructors) { %><li><a href="#constructor_summary"><% } %>Constructor<% if (visibleConstructors) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
757 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
758 if (visibleMethods) { %><li><a href="#method_summary"><% } %>Method<% if (visibleMethods) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
759 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
760 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
761 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
762 <ul class="subNavList">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
763 <li>&nbsp;|&nbsp;Detail:&nbsp;</li>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
764 <%
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
765 if (classDoc.isAnnotationType()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
766 if (hasElements) { %><li><a href="#element_detail"><% } %>Element<% if (hasElements) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
767 } else {
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
768 if (classDoc.isEnum()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
769 if (hasEnumConstants) { %><li><a href="#enum_constant_detail"><% } %>Enum constants<% if (hasEnumConstants) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
770 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
771 if (hasFields) { %><li><a href="#field_detail"><% } %>Field<% if (hasFields) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
772 if (hasProperties) { %><li><a href="#prop_detail">Property</a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
773 if (classDoc.isClass()) {
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
774 if (visibleConstructors) { %><li><a href="#constructor_detail"><% } %>Constructor<% if (visibleConstructors) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
775 }
23
e2d02e8742be usasr-1307: for render tables for properties and reportable properties with label and group names
smith@nwoca.org
parents: 20
diff changeset
776 if (visibleMethods) { %><li><a href="#method_detail"><% } %>Method<% if (visibleMethods) { %></a></li><% } %>&nbsp;&nbsp;&nbsp;<%
16
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
777 }
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
778 %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
779 </ul>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
780 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
781 <% if (props.footer) { %><p>${props.footer}</p><% } %>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
782 <a name="skip-navbar_bottom">
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
783 <!-- -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
784 </a>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
785 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
786 </div>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
787 <!-- ======== END OF BOTTOM NAVBAR ======= -->
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
788 </body>
8400a7db1330 USASR-1307: update templates to groovydoc 2.3.6
smith@nwoca.org
parents: 15
diff changeset
789 </html>