org.jetbrains.kotlin.doc.templates.ClassTemplate.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kdoc Show documentation

There is a newer version: 0.12.1230

package org.jetbrains.kotlin.doc.templates

import org.jetbrains.kotlin.doc.model.KClass
import org.jetbrains.kotlin.doc.model.KModel
import org.jetbrains.kotlin.doc.model.KPackage

open class ClassTemplate(open val model: KModel, pkg: KPackage, open val klass: KClass) : PackageTemplateSupport(pkg) {

    open fun pageTitle(): String = "${klass.name} (${model.title})"

    override fun render() {
        println("""



$generatedComment


${pageTitle()}




${stylesheets()}














""")

        printPrevNextClass()
        println("""




${searchBox()}
  
  
      Overview 
      Package 
    Class 
      Use 
      Tree 
      Deprecated 
      Index 
      Help 








  FRAMES   
 NO FRAMES   
 







  SUMMARY: NESTED | PROPERTY | CONSTR | FUNCTION

DETAIL: PROPERTY | CONSTR | FUNCTION




""")

        printBody()

        println("""
        
        
        """)
                printPrevNextClass()
                println("""
        
        
        
        
          
      Overview 
      Package 
    Class 
      Use 
      Tree 
      Deprecated 
      Index 
      Help 
  
        
        
        
        
        
        

        
  FRAMES   
 NO FRAMES   
 
        


        
        
        
        
          SUMMARY: NESTED | PROPERTY | CONSTR | FUNCTION
        
        DETAIL: PROPERTY | CONSTR | FUNCTION
        
        
        
        

        
        Copyright © 2010-2012. All Rights Reserved.
        
        """)
    }

    open fun printBody(): Unit {
        println("""



${pkg.name}


Class ${klass.simpleName}
""")

        for (bc in klass.baseClasses) {
            println(link(bc, true))
        }
        println("""  ${klass.name}



""")
        printAnnotations(klass.annotations)
        print("""${klass.visibility} ${klass.kindCode} ${klass.simpleName}""")
        if (!klass.baseClasses.isEmpty()) {
            print("""extends """)
            for (bc in klass.baseClasses) {
                println(link(bc))
            }
        }
        println("""



""")
        println(klass.detailedDescription(this))
        if (klass.since.size > 0 || klass.authors.size > 0) {
            println("""

""")
            if (klass.since.size > 0) {
                println("""Since:
  ${klass.since}""")
            }
            for (author in klass.authors) {
                println("""Author:
  ${author}""")
            }
            println("""""")
        }

        println("""

""")
        val nestedClasses = klass.nestedClasses
        if (!nestedClasses.isEmpty()) {
            println("""


""")
            for (nc in nestedClasses) {
                println("""""")
            }
            println("""


Nested Class Summary


static class
${klass.simpleName}.${nc.simpleName}


          ${nc.description(this)}


 """)
        }

        printPropertySummary(klass.properties)
        printFunctionSummary(klass.functions)
        printFunctionDetail(klass.functions)

        println("""

""")
    }

    open fun printPrevNextClass(): Unit {
        println("""""")
        val prev = pkg.previous(klass)
        if (prev != null) {
            println(""" PREV CLASS """)

        }
        val next = pkg.next(klass)
        if (next != null) {
            println(""" NEXT CLASS""")
        }
        println("""""")
    }

}

org.jetbrains.kotlin.doc.templates.ClassTemplate.kt Maven / Gradle / Ivy

${pkg.name} Class ${klass.simpleName}

${pkg.name}
Class ${klass.simpleName}