org.codehaus.groovy.tools.template.class.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




    ${docType.simpleClassName} ($title)
    <%
    int dotCount = docType.packageName.count('.')
    String pathPref = '../' * (dotCount + 1)
    %>
    
    




    
    

    
        
            Overview
            Package
            Class
            Index
        
    

    

    

    
        Package: ${docType.packageName}
        ${docType.interface ? 'Interface' : 'Class'} ${docType.simpleClassName}
    

    

    

        

        
            
                
                    
                        
                            Methods Summary
                            
                                    <% docType.docMethods.eachWithIndex { docMethod, i -> %>
                                    
                                    <% } %>
                                
                               Methods 
                                
                                    
                                        Return type
                                        Name and parameters
                                    

                                        
                                             ${docMethod.isStatic() ? 'static ' : ''}${docMethod.returnTypeDocUrl}
                                        
                                        
                                            ${docMethod.name}(${docMethod.parametersDocUrl})
                                            

                                            ${docMethod.shortComment}
                                        
                                    
                            
                        
                        <% docType.inheritedMethods.each { inhDocType, inhDocMethods -> %>
                        
                            
                            Methods inherited from ${inhDocType.interface ? 'interface' : 'class'} ${inhDocType.packageName}.${docType.linkAnchor(inhDocType)}
                                
                                    <%= inhDocMethods.findAll { !it.static }.collect { docMethod ->
                                        """${docMethod.name}"""
                                    }.join(", ") %>
                                
                            
                        
                        <% } %>
                    
                
            
        

    

    


        
            
                
                    
                        
                            Methods Detail

                            <% docType.docMethods.eachWithIndex { docMethod, i -> %>
                            

                            
                                

                                    public ${docMethod.isStatic() ? 'static ' : ''}${docMethod.returnTypeDocUrl} ${docMethod.name}(${docMethod.parametersDocUrl})

                                    ${docMethod.comment}

                                    <% if (docMethod.parametersSignature) { %>
                                    
                                        Parameters:
                                        <% docMethod.parameterComments.each { name, comment -> %>
                                        ${name} - ${comment}
                                        <% } %>
                                    
                                    <%
                                    } %>

                                    <% if (docMethod.returnComment) { %>
                                    
                                        Returns:
                                        ${docMethod.returnComment}
                                    
                                    <% } %>

                                    <%if (docMethod.sinceComment) { %>
                                    
                                        Since:
                                        ${docMethod.sinceComment}
                                    
                                    <%}%>

                                    <% if (docMethod.seeComments) { %>
                                    
                                        See Also:
                                        <% docMethod.seeComments.each { %>
                                        ${it}
                                        <% }%>
                                    
                                    <% } %>

                                
                            

                            <% } %>

                        
                    
                
            
        

    

    

    
    
    

    
        
            Overview
            Package
            Class
            Index