<%
def parents = classDoc.isInterface() ? classDoc.parentInterfaces : classDoc.parentClasses
if (parents.size() >= 2) {
parents.eachWithIndex { p, i ->
%>- <%
if ( i == parents.size() - 1) {
out << p.qualifiedTypeName()
} else {
%>
<%
}
}
}
%>
-
<%
if (classDoc.isInterface()) {
Set interfaces = classDoc.parentInterfaces
interfaces -= classDoc
if (interfaces) {
%>
- All Superinterfaces:
- ${interfaces.collect{ linkable(it) }.join(', ')}
<%
}
} else {
// TODO follow up the tree collecting interfaces seen?
def interfaces = classDoc.interfaces()
if (interfaces) {
%>
- All Implemented Interfaces and Traits:
- ${interfaces.collect{ linkable(it) }.join(', ')}
${annotations(classDoc, '\n') + modifiers(classDoc) + classDoc.typeSourceDescription + ' ' + classDoc.name()}
<% if (classDoc.isInterface() && classDoc.interfaces()) {
%>extends ${classDoc.interfaces().collect{ linkable(it) }.join(', ')}
<% } else if (classDoc.superclass()) {
%>extends ${linkable(classDoc.superclass())}
<% } %>
<% } %>
<% } %>
<% if (classDoc.commentText()) { %>
${classDoc.commentText()}
<% } %>
-
<% if (visibleNested) { %>
-
Nested Class Summary
Nested classes
| Modifiers |
Name |
Description |
<% visibleNested.eachWithIndex { c, i -> %>
${modifiersBrief(c) + c.typeSourceDescription} |
${linkable(c)} |
${c.firstSentenceCommentText()} |
<% } %>
<% } %>
<% if (hasEnumConstants) { %>
-
Enum Constants Summary
Enum constants classes
| Enum constant |
Description |
<% classDoc.enumConstants().eachWithIndex { ec, i -> %>
${ec.name()} |
${ec.firstSentenceCommentText()} |
<% } %>
<% } %>
<%
def buffer = new StringBuilder()
classes = []
if (classDoc.isInterface()) {
classes.addAll(classDoc.interfaces().toList())
} else {
if (classDoc.superclass()) classes += classDoc.superclass()
else classes += new org.codehaus.groovy.tools.groovydoc.ExternalGroovyClassDoc(Object.class)
}
visited = [classDoc] as Set
while (classes) {
Set nextLevel = []
classes.eachWithIndex { c,i ->
if (c.isInterface()) nextLevel.addAll(c.interfaces().toList())
else if (c.superclass() && c.qualifiedTypeName() != 'java.lang.Object') nextLevel += c.superclass()
nextLevel -= visited
visited += nextLevel
def list = []
if (c instanceof org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc) {
list = c.fields().findAll(isVisible).collect { field ->
"${field.name()}"
}
} else {
list = c.externalClass().fields.findAll{ isVisibleExt(it) }.collect { field ->
// "${field.name()}"
field.name
}
}
if (list) {
buffer << """
${c.typeSourceDescription} ${linkable(c)} |
${list.join(', ')} |
"""
}
}
classes = nextLevel
}
if (hasFields || buffer.length()>0) { %>
<%
if (hasFields) { %>
-
Field Summary
Fields
| Modifiers |
Name |
Description |
<% visibleFields.eachWithIndex { field, i -> %>
${modifiersBrief(field) + linkable(field.type())} |
${field.name()} |
${field.firstSentenceCommentText()} |
<% } %>
<% } // if (hasFields)
if ((buffer.length())>0) { %>
-
Inherited fields
| Fields inherited from class |
Fields |
${buffer}
<% } // if buffer %>
<% } // if hasFields or buffer %>
<% if (hasProperties) { %>
-
Properties Summary
Properties
| Type |
Name and description |
<% visibleProperties.eachWithIndex { prop, i -> %>
${modifiersBrief(prop) + linkable(prop.type())} |
${prop.name()}
${prop.firstSentenceCommentText()} |
<% } %>
<% } %>
<% if (hasElements) { %>
-
Element Summary
<% elementTypes.each { k, v ->
%><%
if (visibleFields.any{ isRequired(it, v) }) { %>
${upcase(k)} Element Summary
| Type |
Name and Description |
<% visibleFields.findAll {isRequired(it, v)}.eachWithIndex { element, i -> %>
${modifiersBrief(element) + linkable(element.type())} |
${element.name()}
${element.firstSentenceCommentText()} |
<% } %>
<% }
} //elementTypes.each %>
<% } %>
<% if (visibleConstructors) { %>
-
Constructor Summary
Constructors
| Constructor and description |
<% visibleConstructors.eachWithIndex { constructor, i -> %>
${modifiersBrief(constructor)}${constructor.name()}
(${paramsOf(constructor, true)})
${constructor.firstSentenceCommentText()} |
<% } %>
<% } %>
<%
buffer = new StringBuilder()
Set classes = []
if (classDoc.isInterface()) {
classes.addAll(classDoc.interfaces().toList())
} else {
if (classDoc.superclass()) classes += classDoc.superclass()
else if (!classDoc.isTrait()) classes += new org.codehaus.groovy.tools.groovydoc.ExternalGroovyClassDoc(Object.class)
}
Set visited = [classDoc] as Set
while (classes) {
Set nextLevel = []
classes.eachWithIndex { c,i ->
if (c.isInterface()) nextLevel.addAll(c.interfaces().toList())
else if (c.superclass() && c.qualifiedTypeName() != 'java.lang.Object') nextLevel += c.superclass()
nextLevel -= visited
visited += nextLevel
def list = []
if (c instanceof org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc) {
list = c.methods().findAll(isVisible).collect { method ->
"${method.name()}"
}
} else {
list = c.externalClass().methods.findAll{ isVisibleExt(it) }.collect { method ->
linkable(c.externalClass().name + "#" + nameFromJavaParams(method) + " " + method.name)
}
}
if (list) {
buffer << """
${c.typeSourceDescription} ${linkable(c)} |
${list.join(', ')} |
"""
}
}
classes = nextLevel
}
if (visibleMethods || buffer.length()>0) { %>
<% if (visibleMethods) { %>
-
Methods Summary
Methods
| Type Params |
Return Type |
Name and description |
<% visibleMethods.eachWithIndex { method, i -> %>
${org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc .encodeAngleBrackets(method.typeParameters())} |
${modifiersBrief(method)}${linkable(method.returnType())} |
${method.name()}(${paramsOf(method, true)})
${method.firstSentenceCommentText()} |
<% } %>
<% } // if (visibleMethods)
if (buffer.length()>0) {
%>
-
Inherited Methods Summary
Inherited Methods
| Methods inherited from class |
Name |
${buffer}
<%
} // if buffer.length%>
<% } %>
-
<% if (hasEnumConstants) { %>
-
Enum Constant Detail
<% for (ec in classDoc.enumConstants()) { %>
<% } %>
<% } %>
<% if (hasFields) { %>
-
Field Detail
<% visibleFields.each { field -> %>
-
${annotations(field, '\n') + modifiersWithIgnore(field, false) + linkable(field.type())} ${field.name()}
${field.commentText()}
<% } %>
<% } %>
<% if (hasProperties) { %>
-
Property Detail
<% visibleProperties.each { prop -> %>
-
${annotations(prop, '\n') + modifiers(prop) + linkable(prop.type())} ${prop.name()}
${prop.commentText()}
<% } %>
<% } %>
<% if (hasElements) { %>
-
Element Detail
<% visibleFields.each { element -> %>
-
${modifiers(element) + linkable(element.type())} ${element.name()}
${element.commentText()}
<% } %>
<% } %>
<% if (visibleConstructors) { %>
-
Constructor Detail
<% visibleConstructors.each { constructor -> %>
<% } %>
<% } %>
<% if (visibleMethods) { %>
-
Method Detail
<% visibleMethods.each { method -> %>
-
${method.typeParameters() ?
org.codehaus.groovy.tools.groovydoc.SimpleGroovyClassDoc.encodeAngleBrackets(method.typeParameters()) + ' ' : ''}${annotations(method, '\n') + modifiers(method)}${linkable(method.returnType())} ${method.name()}(${paramsOf(method, false)})
${method.commentText()}
<% } %>
<% } %>
<% if (props.footer) { %>
${props.footer}
<% } %>