[lvcs] add doc for LocalHistoryFacade

GitOrigin-RevId: f9f45c0a75d0fd39e57c7a8e8e1009cfdc6eabe4
This commit is contained in:
Dmitry Zhuravlev
2024-09-23 11:26:36 +02:00
committed by intellij-monorepo-bot
parent fa172ef7d3
commit d8bc13e796
2 changed files with 13 additions and 0 deletions

View File

@@ -23,6 +23,13 @@ import org.jetbrains.annotations.ApiStatus
import org.jetbrains.annotations.TestOnly
import java.nio.file.Path
/**
* Facade for managing local history operations.
*
* Provides methods for managing [com.intellij.history.core.changes.Change].
* E.g., modifying content, renaming, changing read-only status, moving, and deleting.
* It also allows adding and managing system and user labels and aggregate changes by [ActivityId]
*/
open class LocalHistoryFacade internal constructor() {
internal val storageDir: Path

View File

@@ -5,6 +5,12 @@ import com.intellij.history.LocalHistory
import com.intellij.history.core.LocalHistoryFacade
import com.intellij.openapi.Disposable
/**
* Provides API access to [LocalHistoryImpl]
*/
abstract class LocalHistoryEx : LocalHistory(), Disposable {
/**
* return null if [LocalHistoryImpl] disabled or not initialized
*/
abstract val facade: LocalHistoryFacade?
}