org.jetbrains.kotlin.kdoc.psi.api.KDoc.kt Maven / Gradle / Ivy

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

the Kotlin compiler

There is a newer version: 2.0.0

/*
 * Copyright 2010-2015 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jetbrains.kotlin.kdoc.psi.api

import com.intellij.psi.PsiComment
import org.jetbrains.kotlin.kdoc.psi.impl.KDocSection
import org.jetbrains.kotlin.psi.KtDeclaration
import org.jetbrains.kotlin.kdoc.parser.KDocKnownTag

// Don't implement JetElement (or it will be treated as statement)
interface KDoc : PsiComment, KDocElement {
    fun getOwner(): KtDeclaration?
    fun getDefaultSection(): KDocSection
    fun findSectionByName(name: String): KDocSection?
    fun findSectionByTag(tag: KDocKnownTag): KDocSection?
    fun findSectionByTag(tag: KDocKnownTag, subjectName: String): KDocSection?
}