From 5f1a42177cb281558d30fceb564babd5482ce38b Mon Sep 17 00:00:00 2001 From: Yann Cebron Date: Sat, 25 Dec 2010 15:54:56 +0100 Subject: [PATCH] doc --- .../src/com/intellij/psi/FileViewProvider.java | 10 +++++++++- .../src/com/intellij/psi/FileViewProviderFactory.java | 5 ++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/platform/lang-api/src/com/intellij/psi/FileViewProvider.java b/platform/lang-api/src/com/intellij/psi/FileViewProvider.java index 2e8b8a68f237..ae9d4dafb3c7 100644 --- a/platform/lang-api/src/com/intellij/psi/FileViewProvider.java +++ b/platform/lang-api/src/com/intellij/psi/FileViewProvider.java @@ -1,5 +1,5 @@ /* - * Copyright 2000-2009 JetBrains s.r.o. + * Copyright 2000-2010 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. @@ -26,6 +26,14 @@ import org.jetbrains.annotations.Nullable; import java.util.List; import java.util.Set; +/** + * Manages language-specific access to PSI for a single file. + *

+ * Custom providers are registered via {@link FileViewProviderFactory}. + * + * @see com.intellij.psi.PsiFile#getViewProvider() + * @see PsiManager#findViewProvider(com.intellij.openapi.vfs.VirtualFile) + */ public interface FileViewProvider extends Cloneable, UserDataHolder { @NotNull PsiManager getManager(); diff --git a/platform/lang-api/src/com/intellij/psi/FileViewProviderFactory.java b/platform/lang-api/src/com/intellij/psi/FileViewProviderFactory.java index 2451a90d1ed9..a59327bf1409 100644 --- a/platform/lang-api/src/com/intellij/psi/FileViewProviderFactory.java +++ b/platform/lang-api/src/com/intellij/psi/FileViewProviderFactory.java @@ -1,5 +1,5 @@ /* - * Copyright 2000-2009 JetBrains s.r.o. + * Copyright 2000-2010 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. @@ -20,6 +20,9 @@ import com.intellij.lang.Language; import com.intellij.openapi.vfs.VirtualFile; /** + * Register in extension point {@code com.intellij.fileType.fileViewProviderFactory} + * or {@code com.intellij.lang.fileViewProviderFactory}. + * * @author yole */ public interface FileViewProviderFactory {