org.codehaus.groovy.tools.groovydoc.gstringTemplates.packageLevel.package-summary.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of groovy-all Show documentation

Groovy: A powerful, dynamic language for the JVM

There is a newer version: 3.0.22





<%
def isVisible = { it.isPublic() || (it.isProtected() && props.protectedScope == 'true') || (!it.isProtected() && !it.isPrivate() && props.packageScope == 'true') || props.privateScope == 'true' }
def title = packageDoc.nameWithDots() + (props.windowTitle ? " ($props.windowTitle)" : "")
// TODO enable errors(), enums() etc in SimpleGroovyPackageDoc then replace closures below
def classTypes = [
    "Interface" : { it.isInterface() },
    "Trait" : { it.isTrait() },
    "Class" : { it.isClass() && !it.parentClasses*.qualifiedTypeName().contains('java.lang.Throwable') },
    "Enum" : { it.isEnum() },
    "Exception" : { it.isClass() && it.parentClasses*.qualifiedTypeName().contains('java.lang.Exception') },
    "Error" : { it.isClass() && it.parentClasses*.qualifiedTypeName().contains('java.lang.Error') },
    "Annotation Type" : { it.isAnnotationType() },
    "Script" : { it.isScript() }
]
%>
${title}














    

    



    Overview
    Package
    Class
    Deprecated
    Index
    Help




    
        Frames
        No Frames
    





    Package ${packageDoc.nameWithDots()}


<% if (!packageDoc.description().trim().isEmpty()) { %>
Package ${packageDoc.nameWithDots()} Description
${packageDoc.description()}
<% } %>


<%
classTypes.each { k, v ->
    if (packageDoc.allClasses().any{ isVisible(it) && v(it) }) {
%>

    
        
            
                
<%
        for (classDoc in packageDoc.allClasses().findAll{ isVisible(it) && v(it) }) {
            def i = 0
                        %>
<%  } %>
                    
                    ${k} Summary 
                    
                    
                        ${k}
                        Description
                    

                            
                                
                                    ${classDoc.name()}
                                
                            
                            ${classDoc.firstSentenceCommentText()}
                        
                
            
            
        
    <% } %>
<% } %>




    

    

    
        Overview
        Package
        Class
        Deprecated
        Index
        Help
    


    
        
            Frames
            No Frames
        
    

    ${props['footer']?:""}